Skip to content

Commit

Permalink
Fix internal refs in Markdown files
Browse files Browse the repository at this point in the history
  • Loading branch information
theletterf committed Sep 8, 2023
1 parent 2d276bd commit 9bf40cb
Show file tree
Hide file tree
Showing 18 changed files with 28 additions and 26 deletions.
4 changes: 2 additions & 2 deletions _includes/benefits-events.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Configure the integration to access these features:

- View events. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see [View dashboards in Observability Cloud](https://docs.splunk.com/Observability/data-visualization/dashboards/view-dashboards.html#nav-View-dashboards).
- View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see [Splunk Infrastructure Monitoring navigators](https://docs.splunk.com/Observability/infrastructure/navigators/navigators.html#nav-Splunk-Infrastructure-Monitoring-navigators).
- View events. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see {ref}`view-dashboards`.
- View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see {ref}`use-navigators-imm`.

6 changes: 3 additions & 3 deletions _includes/benefits.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
After you configure the integration, you can access these features:

- View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see [View dashboards in Observability Cloud](https://docs.splunk.com/Observability/data-visualization/dashboards/view-dashboards.html#nav-View-dashboards).
- View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see [Splunk Infrastructure Monitoring navigators](https://docs.splunk.com/Observability/infrastructure/navigators/navigators.html#nav-Splunk-Infrastructure-Monitoring-navigators).
- Access the Metric Finder and search for metrics sent by the monitor. For information, see [Use the Metric Finder](https://docs.splunk.com/Observability/metrics-and-metadata/metrics-finder-metadata-catalog.html#use-the-metric-finder).
- View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see {ref}`view-dashboards`.
- View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see {ref}`use-navigators-imm`.
- Access the Metric Finder and search for metrics sent by the monitor. For information, see {ref}`metrics-finder-and-metadata-catalog`.
6 changes: 3 additions & 3 deletions _includes/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ To use this integration of a Smart Agent monitor with the Collector:
1. Include the Smart Agent receiver in your configuration file.
2. Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.

- Read more on how to [Use Smart Agent monitors with the Collector](https://docs.splunk.com/Observability/gdi/opentelemetry/smart-agent-migration-monitors.html).
- See how to set up the [Smart Agent receiver](https://docs.splunk.com/observability/gdi/opentelemetry/components/smartagent-receiver.html).
- Learn about config options in [Collector default configuration](https://docs.splunk.com/Observability/gdi/opentelemetry/configure-the-collector-ootb.html#nav-Collector-default-configuration).
- Read more on how to {ref}`migration-monitors`.
- See how to set up the {ref}`smartagent-receiver`.
- Learn about config options in {ref}`otel-configuration-ootb`.


6 changes: 3 additions & 3 deletions _includes/metric-defs.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
- Learn more about the available [metric types](https://docs.splunk.com/Observability/metrics-and-metadata/metric-types.html#nav-Metric-types) in Observability Cloud.
- In host-based subscription plans, default metrics are those metrics included in host-based subscriptions in Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See more about [metric categories](https://docs.splunk.com/Observability/metrics-and-metadata/metric-categories.html#nav-Metric-categories).
- To learn more about the available in Observability Cloud see {ref}`metric-types`.
- In host-based subscription plans, default metrics are those metrics included in host-based subscriptions in Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See {ref}`metric-categories` for more information.
- In MTS-based subscription plans, all metrics are custom.
- To add additional metrics, see how to configure `extraMetrics` [using the Collector](https://docs.splunk.com/Observability/gdi/opentelemetry/components/smartagent-receiver.html#add-additional-metrics).
- To add additional metrics, see how to configure `extraMetrics` in {ref}`otel-sareceiver-extrametrics`.
2 changes: 1 addition & 1 deletion _includes/missing_pipeline_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ service:
exporters: [otlp, jaeger, zipkin]
```

See [How the OpenTelemetry Collector uses pipelines to process data](https://docs.splunk.com/observability/gdi/opentelemetry/data-processing.html#common-processing-scenarios) for more information.
See {ref}`otel-data-processing` for more information.
2 changes: 1 addition & 1 deletion _includes/out_of_memory_error.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ For example, if you discover that the pod lasts 5 minutes before it gets killed:

How long does it take for the pod to be killed due to memory limit? Check the logs at the time of the issue to see if there are any obvious repeating errors.

Gather additional [support information](https://docs.splunk.com/Observability/gdi/opentelemetry/support-checklist.html#nav-Gather-information-to-open-a-support-request), including your end-to-end architecture information.
Gather additional support information, including your end-to-end architecture information. See {ref}`otel-support-checklist`.
2 changes: 1 addition & 1 deletion gdi/monitors-cloud/heroku.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Use the following environment variables to configure the Heroku buildpack.

| Environment Variable | Required | Default | Description |
| ---------------------- | -------- | ------- | ------------------------------------------------------------------------- |
| `SPLUNK_ACCESS_TOKEN` | Yes | | [Splunk access token](https://docs.splunk.com/Observability/admin/authentication-tokens/org-tokens.html#admin-org-tokens). |
| `SPLUNK_ACCESS_TOKEN` | Yes | | Splunk access token. |
| `SPLUNK_REALM` | Yes | | [Splunk realm](https://dev.splunk.com/observability/docs/realms_in_endpoints/). |
| `SPLUNK_API_URL` | No | `https://api.SPLUNK_REALM.signalfx.com` | The Splunk API base URL. |
| `SPLUNK_CONFIG` | No | `/app/config.yaml` | The configuration to use. `/app/.splunk/config.yaml` used if default not found. |
Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-databases/postgresql.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The following table shows the configuration options for the `postgresql` integra
| `masterDBName` | no | `string` | The "master" database to which the agent first connects to query the list of databases available in the server. This database should be accessible to the user specified with `connectionString` and `params` below, and that user should have permission to query `pg_database`. If you want to filter which databases are monitored, use the `databases` option below. (**default:** `postgres`) |
| `connectionString` | no | `string` | See [Connection String Parameters](https://godoc.org/github.com/lib/pq#hdr-Connection_String_Parameters). |
| `params` | no | `map of strings` | Parameters to the connection string that can be templated into the connection string with the syntax `{{.key}}`. |
| `databases` | no | `list of strings` | List of databases to send database-specific metrics about. If omitted, metrics about all databases will be sent. This is an [overridable set](https://docs.splunk.com/Observability/gdi/smart-agent/smart-agent-resources.html#filtering-data-using-the-smart-agent). (**default:** `[*]`) |
| `databases` | no | `list of strings` | List of databases to send database-specific metrics about. If omitted, metrics about all databases will be sent. This is an {ref}`overridable set <filtering-smart-agent>`. (**default:** `[*]`) |
| `databasePollIntervalSeconds` | no | `integer` | How frequently to poll for new/deleted databases in the DB server. Defaults to the same as `intervalSeconds` if not set. (**default:** `0`) |
| `logQueries` | no | `bool` | If `true,` queries will be logged at the info level. (**default:** `false`) |
| `topQueryLimit` | no | `integer` | The number of top queries to consider when publishing query-related metrics (**default:** `10`) |
Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-hosts/apache-tomcat.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<meta name="description" content="Use this Splunk Observability Cloud integration for the Collectd Tomcat monitor. See benefits, install, configuration, and metrics">

The {ref}`Splunk Distribution of OpenTelemetry Collector <otel-intro>` uses the {ref}`Smart Agent receiver <smartagent-receiver>` with the Collectd Tomcat monitor type to monitor Tomcat. You must activate JMX Remote to monitor Tomcat remotely. See [GenericJMX](https://docs.splunk.com/Observability/gdi/monitors-languages/genericjmx.html) for more information.
The {ref}`Splunk Distribution of OpenTelemetry Collector <otel-intro>` uses the {ref}`Smart Agent receiver <smartagent-receiver>` with the Collectd Tomcat monitor type to monitor Tomcat. You must activate JMX Remote to monitor Tomcat remotely. See {ref}`GenericJMX <genericjmx>` for more information.

This integration is only available on Kubernetes and Linux.

Expand Down
4 changes: 2 additions & 2 deletions gdi/monitors-hosts/filesystems.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ The following table shows the configuration options for this monitor.
| Option | Required | Type | Description |
| --- | --- | --- | --- |
| `hostFSPath` | no | `string` | Path to the root of the host filesystem. It is useful when running in a container and the host filesystem is mounted in a subdirectory under /. The disk usage metrics emitted will be based at this path. |
| `fsTypes` | no | `list of strings` | The filesystem types to include/exclude. This is an [overridable set](https://docs.splunk.com/Observability/gdi/smart-agent/smart-agent-resources.html#filtering-data-using-the-smart-agent). If this is not set, the default value is the set of all **non-logical/virtual filesystems** on the system. On Linux this list is determined by reading the `/proc/filesystems` file and choosing the filesystems that do not have the `nodev` modifier. |
| `mountPoints` | no | `list of strings` | The mount paths to include/exclude. This is an [overridable set](https://docs.splunk.com/Observability/gdi/smart-agent/smart-agent-resources.html#filtering-data-using-the-smart-agent). **Note**: If you are using the hostFSPath option, do not include the `/hostfs/` mount in the filter. If both this and `fsTypes` are specified, the two filters combine in an AND relationship. |
| `fsTypes` | no | `list of strings` | The filesystem types to include/exclude. This is an {ref}`overridable set <filtering-smart-agent>`. If this is not set, the default value is the set of all **non-logical/virtual filesystems** on the system. On Linux this list is determined by reading the `/proc/filesystems` file and choosing the filesystems that do not have the `nodev` modifier. |
| `mountPoints` | no | `list of strings` | The mount paths to include/exclude. This is an {ref}`overridable set <filtering-smart-agent>`. **Note**: If you are using the hostFSPath option, do not include the `/hostfs/` mount in the filter. If both this and `fsTypes` are specified, the two filters combine in an AND relationship. |
| `sendModeDimension` | no | `bool` | Set to `true` to emit the "mode" dimension, which represents whether the mount is "rw" or "ro". (**default:** `false`) |

## Metrics
Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-languages/genericjmx.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<meta name="description" content="Use this Splunk Observability Cloud integration for the GenericJMX monitor. See benefits, install, configuration, and metrics">

The {ref}`Splunk Distribution of OpenTelemetry Collector <otel-intro>` uses the {ref}`Smart Agent receiver <smartagent-receiver>` with the `genericjmx` monitor to expose metrics on Java Management Extensions (JMX), a generic framework to provide and query management information. The interface is used by the Java Virtual Machine (JVM) to provide information about the memory used and threads. For a more flexible alternative, use [the JMX monitor](https://docs.splunk.com/Observability/gdi/jmx/jmx.html).
The {ref}`Splunk Distribution of OpenTelemetry Collector <otel-intro>` uses the {ref}`Smart Agent receiver <smartagent-receiver>` with the `genericjmx` monitor to expose metrics on Java Management Extensions (JMX), a generic framework to provide and query management information. The interface is used by the Java Virtual Machine (JVM) to provide information about the memory used and threads. For a more flexible alternative, use {ref}`the JMX monitor <genericjmx>`.

This integration is only available on Kubernetes and Linux.

Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-languages/jmx.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<meta name="description" content="Use this Splunk Observability Cloud integration for the JMX monitor. See benefits, install, configuration, and metrics. Run an arbitrary Groovy script to convert JMX MBeans fetched from a remote Java application to SignalFx data points">

The {ref}`Splunk Distribution of OpenTelemetry Collector <otel-intro>` uses the {ref}`Smart Agent receiver <smartagent-receiver>` with the `jmx` monitor type to run an arbitrary Groovy script to convert JMX MBeans fetched from a remote Java application to SignalFx data points. This is a more flexible alternative to the [GenericJMX](https://docs.splunk.com/Observability/gdi/monitors-languages/genericjmx.html) monitor.
The {ref}`Splunk Distribution of OpenTelemetry Collector <otel-intro>` uses the {ref}`Smart Agent receiver <smartagent-receiver>` with the `jmx` monitor type to run an arbitrary Groovy script to convert JMX MBeans fetched from a remote Java application to SignalFx data points. This is a more flexible alternative to the {ref}`GenericJMX <genericjmx>` monitor.

You can use the following utility helpers in the Groovy script within the `util` variable, which is set in the script's context:

Expand Down
4 changes: 2 additions & 2 deletions gdi/monitors-monitoring/nagios.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@

The {ref}`Splunk Distribution of OpenTelemetry Collector <otel-intro>` uses the {ref}`Smart Agent receiver <smartagent-receiver>` with the Nagios monitor type to run existing Nagios status check scripts through the Collector, which acts as the Nagios Remote Plugin Executor (NRPE) or the Simple Network Management Protocol (SNMP) exec directive, and send the [state](https://nagios-plugins.org/doc/guidelines.html#AEN78) of the check, depending on the exit code of the command.

This integration is similar to the [telegraf/exec monitor configured with dataFormat:nagios integration](https://docs.splunk.com/Observability/gdi/exec/telegraf-exec.html), with the following exceptions:
This integration is similar to the telegraf/exec monitor configured with dataFormat:nagios integration, with the following exceptions:

- It does not retrieve perfdata metrics. This integration only retrieves the state of the script for alerting purposes.
- It overrides the state if the exit code `== 0`, but the output string starts with `warn`, `crit`, or `unkn` (not case-sensitive).

This integration adds more context to the status check state by using [events](https://docs.splunk.com/Observability/alerts-detectors-notifications/view-data-events.html#events-intro). In addition to the `state` metric, it also sends an event that includes the output and the error caught from the command execution.
This integration adds more context to the status check state by using events. In addition to the `state` metric, it also sends an event that includes the output and the error caught from the command execution.

Using this integration should make troubleshooting more efficient and let you remain in Splunk Observability Cloud without connecting to your Linux or Windows machine in case of an abnormal state to understand what is happening. Using this integration also lets you create a dashboard that is familiar to Nagios users.

Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-network/net-io.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The following table shows the configuration options for the `net-io` integration

| Option | Required | Type | Description |
| --- | --- | --- | --- |
| `interfaces` | no | `list of strings` | The network interfaces to send metrics about. This is an [overridable set](https://docs.splunk.com/Observability/gdi/smart-agent/smart-agent-resources.html#filtering-data-using-the-smart-agent). (**default:** `[* !/^lo\d*$/ !/^docker.*/ !/^t(un|ap)\d*$/ !/^veth.*$/ !/^Loopback*/]`) |
| `interfaces` | no | `list of strings` | The network interfaces to send metrics about. This is an {ref}`overridable set <filtering-smart-agent>`. (**default:** `[* !/^lo\d*$/ !/^docker.*/ !/^t(un|ap)\d*$/ !/^veth.*$/ !/^Loopback*/]`) |

On Linux hosts, this monitor relies on the `/proc` filesystem. If the underlying host's `/proc` file system is mounted somewhere other than `/proc`, specify the path using the top-level configuration `procPath`.

Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-orchestration/kubernetes-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The **nested** `kubernetesAPI` configuration object has the following fields:

## Metrics

The following table shows the legacy metrics that are available for this integration. See [OpenTelemetry values and their legacy equivalents](https://docs.splunk.com/Observability/gdi/opentelemetry/legacy-otel-mappings.html#opentelemetry-values-and-their-legacy-equivalents) for the Splunk Distribution of OpenTelemetry Collector equivalents.
The following table shows the legacy metrics that are available for this integration. See {ref}`legacy-otel-mappings` for the Splunk Distribution of OpenTelemetry Collector equivalents.

<div class="metrics-yaml" url="https://raw.githubusercontent.com/signalfx/splunk-otel-collector/main/internal/signalfx-agent/pkg/monitors/kubernetes/cluster/metadata.yaml"></div>

Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-orchestration/openshift-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<meta name="description" content="Use this Splunk Observability Cloud integration for the OpenShift cluster monitor. See benefits, install, configuration, and metrics">

The {ref}`Splunk Distribution of OpenTelemetry Collector <otel-intro>` uses the {ref}`Smart Agent receiver <smartagent-receiver>` with the `openshift-cluster` monitor type to collect cluster-level metrics from the Kubernetes API server, which includes all metrics from the [kubernetes-cluster monitor](https://docs.splunk.com/Observability/gdi/kubernetes-cluster/kubernetes-cluster.html#nav-Kubernetes-cluster) with additional OpenShift-specific metrics. You only need to use the `openshift-cluster` monitor for OpenShift deployments, as it incorporates the `kubernetes-cluster` monitor automatically.
The {ref}`Splunk Distribution of OpenTelemetry Collector <otel-intro>` uses the {ref}`Smart Agent receiver <smartagent-receiver>` with the `openshift-cluster` monitor type to collect cluster-level metrics from the Kubernetes API server, which includes all metrics from {ref}`kubernetes-cluster` with additional OpenShift-specific metrics. You only need to use the `openshift-cluster` monitor for OpenShift deployments, as it incorporates the `kubernetes-cluster` monitor automatically.

This monitor is available on Kubernetes, Linux, and Windows.

Expand Down
Loading

0 comments on commit 9bf40cb

Please sign in to comment.