Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.
Merged
16 changes: 8 additions & 8 deletions gdi/get-data-in/application/span-attributes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,21 @@ Semantic conventions

The following semantic conventions apply for spans:

- :new-page:`General <https://github.com/open-telemetry/semantic-conventions/blob/main/model/general.yaml>`: General semantic attributes that might be used in describing different kinds of operations.
- :new-page:`General <https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/attributes.md>`: General semantic attributes that might be used in describing different kinds of operations.

- :new-page:`HTTP <https://github.com/open-telemetry/semantic-conventions/blob/main/model/trace/http.yaml>`: For HTTP client and server spans.
- :new-page:`HTTP <https://github.com/open-telemetry/semantic-conventions/blob/main/model/http/spans.yaml>`: For HTTP client and server spans.

- :new-page:`Database <https://github.com/open-telemetry/semantic-conventions/blob/main/model/trace/database.yaml>`: For SQL and NoSQL client call spans.
- :new-page:`Database <https://github.com/open-telemetry/semantic-conventions/blob/main/model/database/spans.yaml>`: For SQL and NoSQL client call spans.

- :new-page:`RPC/RMI <https://github.com/open-telemetry/semantic-conventions/blob/main/model/trace/rpc.yaml>`: For remote procedure call (for example, gRPC) spans.
- :new-page:`RPC/RMI <https://github.com/open-telemetry/semantic-conventions/blob/main/model/rpc/spans.yaml>`: For remote procedure call (for example, gRPC) spans.

- :new-page:`Messaging <https://github.com/open-telemetry/semantic-conventions/blob/main/model/trace/messaging.yaml>`: For messaging system spans (queues, publish/subscribe, and so on).
- :new-page:`Messaging <https://github.com/open-telemetry/semantic-conventions/blob/main/model/messaging/spans.yaml>`: For messaging system spans (queues, publish/subscribe, and so on).

- :new-page:`FaaS <https://github.com/open-telemetry/semantic-conventions/blob/main/model/trace/faas.yaml>`: For Function as a Service (for example, AWS Lambda) spans.
- :new-page:`FaaS <https://github.com/open-telemetry/semantic-conventions/blob/main/model/faas/spans.yaml>`: For Function as a Service (for example, AWS Lambda) spans.

- :new-page:`Exceptions <https://github.com/open-telemetry/semantic-conventions/blob/main/model/trace/trace-exception.yaml>`: For recording exceptions associated with a span.
- :new-page:`Exceptions <https://github.com/open-telemetry/semantic-conventions/blob/main/model/exceptions/events.yaml>`: For recording exceptions associated with a span.

- :new-page:`Compatibility <https://github.com/open-telemetry/semantic-conventions/blob/main/model/trace/compatibility.yaml>`: For spans generated by compatibility components. For example, OpenTracing Shim layer.
- :new-page:`Compatibility <https://github.com/open-telemetry/semantic-conventions/blob/main/model/opentracing/common.yaml>`: For spans generated by compatibility components. For example, OpenTracing Shim layer.

Learn more about OpenTelemetry in the OpenTelemetry official documentation, such as library-specific semantic conventions for AWS Lambda, AWS SDK, or GraphQL.

Expand Down
4 changes: 2 additions & 2 deletions gdi/monitors-cloud/kong.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Installation
Kong installation
~~~~~~~~~~~~~~~~~

Follow the official Kong instructions to expose the Prometheus metrics endpoint. To learn how, see the official :new-page:`Kong documentation on Prometheus <https://docs.konghq.com/hub/kong-inc/prometheus>`. Use Kong version 3.4 or higher.
Follow the official Kong instructions to expose the Prometheus metrics endpoint. To learn how, see the official :new-page:`Kong documentation <https://docs.konghq.com/hub/kong-inc/prometheus>` on Prometheus. Use Kong version 3.4 or higher.

Configuration
-------------
Expand All @@ -74,7 +74,7 @@ Next, activate the ``metrics`` pipeline:
Metrics
-------

For the complete list of metrics provided by the integration, refer to :new-page:`Kong Docs on Prometheus <https://docs.konghq.com/hub/kong-inc/prometheus>`.
For the complete list of metrics provided by the integration, refer to :new-page:`Kong Docs <https://docs.konghq.com/hub/kong-inc/prometheus>` on Prometheus.

Notes
~~~~~
Expand Down
11 changes: 3 additions & 8 deletions gdi/monitors-databases/mongodb.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,11 @@ MongoDB (deprecated)
=================================

.. meta::
:description: Use this Splunk Observability Cloud integration for the MongoDB monitor. See benefits, install, configuration, and metrics
:description: Use this Splunk Observability Cloud integration for the MongoDB monitor. See benefits, install, configuration, and metrics.

.. note:: The MongoDB monitor is deprecated and will reach end of support on January 15, 2025. During this period, only critical security and bug fixes are provided. When the monitor reaches end of support, you won't be able to use it to send data to Splunk Observability Cloud.
.. note:: The MongoDB monitor is deprecated and will reach end of support on January 15, 2025. During this period, only critical security and bug fixes are provided. When the monitor reaches end of support, you won't be able to use it to send data to Splunk Observability Cloud. To monitor your MongoDB databases, you can instead use the native OpenTelemetry MongoDB receiver. See :ref:`mongodb-receiver` to learn more.

To monitor your MongoDB databases, you can instead use the native OpenTelemetry MongoDB receiver. See :ref:`mongodb-receiver` to learn more.

The
:ref:`Splunk Distribution of the OpenTelemetry Collector <otel-intro>`
uses the :ref:`Smart Agent receiver <smartagent-receiver>` with the
MongoDB monitor type to capture the following metrics about MongoDB:
The :ref:`Splunk Distribution of the OpenTelemetry Collector <otel-intro>` uses the :ref:`Smart Agent receiver <smartagent-receiver>` with the MongoDB monitor type to capture the following metrics about MongoDB:

- Memory
- Network input/output bytes count
Expand Down
7 changes: 2 additions & 5 deletions gdi/monitors-hosts/apache-tomcat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,9 @@ Apache Tomcat
=============

.. meta::
:description: Use this Splunk Observability Cloud integration for the Collectd Tomcat monitor. See benefits, install, configuration, and metrics
:description: Use this Splunk Observability Cloud integration for the Collectd Tomcat monitor. See benefits, install, configuration, and metrics.

The Splunk Distribution of OpenTelemetry Collector uses the Smart Agent 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.
The :ref:`Splunk Distribution of the 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: 1 addition & 3 deletions gdi/monitors-hosts/jenkins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@ Jenkins
.. meta::
:description: Use this Splunk Observability Cloud integration for the Jenkins monitor. See benefits, install, configuration, and metrics

The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the
``jenkins`` monitor type to collect metrics from Jenkins instances by
hitting the following endpoints:
The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``jenkins`` monitor type to collect metrics from Jenkins instances by hitting the following endpoints:

- Job metrics with the ``../api/json`` endpoint.
- Codahale or Dropwizard JVM metrics with the ``metrics/<MetricsKey>/..`` endpoint.
Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-hosts/kafka-consumer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent rece

.. note:: To monitor Kafka with the OpenTelemetry Collector using native OpenTelemetry components refer to the :ref:`kafkametrics-receiver` component.

This integration has a set of built-in MBeans to pull metrics from the Kafka consumer's JMX endpoint. For more information, see :new-page:`Kafka consumer MBeans <https://github.com/signalfx/signalfx-agent/tree/main/pkg/monitors/collectd/kafkaconsumer/mbeans.go>` in GitHub.
This integration has a set of built-in MBeans to pull metrics from the Kafka consumer's JMX endpoint. For more information, see :new-page:`Kafka consumer MBeans<https://github.com/signalfx/signalfx-agent/tree/main/pkg/monitors/collectd/kafkaconsumer/mbeans.go>` in GitHub.

This integration is only available on Kubernetes and Linux, and requires Kafka version 0.9.0.0 or higher.

Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-hosts/kafka-producer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent rece

.. note:: To monitor Kafka with the OpenTelemetry Collector using native OpenTelemetry components refer to the :ref:`kafkametrics-receiver` component.

This integration has a set of built-in MBeans to pull metrics from the Kafka producer's JMX endpoint. For more information, see :new-page:`Kafka producer MBeans <https://github.com/signalfx/signalfx-agent/tree/main/pkg/monitors/collectd/kafkaproducer/mbeans.go>` in GitHub.
This integration has a set of built-in MBeans to pull metrics from the Kafka producer's JMX endpoint. For more information, see :new-page:`Kafka producer MBeans<https://github.com/signalfx/signalfx-agent/tree/main/pkg/monitors/collectd/kafkaproducer/mbeans.go>` in GitHub.

This integration is only available on Kubernetes and Linux, and requires Kafka version 0.9.0.0 or higher.

Expand Down
2 changes: 1 addition & 1 deletion gdi/monitors-languages/expvar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Expvar (Go)

The :ref:`Splunk Distribution of OpenTelemetry Collector <otel-intro>` uses the :ref:`Smart Agent receiver <smartagent-receiver>` with the ``expvar`` monitor type to scrape metrics exposed Expvar. See :new-page:`expvar <https://golang.org/pkg/expvar/>` to learn more.

The integration uses configured paths to get metric and dimension values from fetched JSON objects at an HTTP endpoint. The Metrics section in this document shows metrics derived from expvar variable :new-page:`memstats <https://golang.org/pkg/runtime/>`, which is exposed by default. These ``memstat`` metrics are referred to as standard or default metrics.
The integration uses configured paths to get metric and dimension values from fetched JSON objects at an HTTP endpoint. The Metrics section in this document shows metrics derived from the :new-page:`memstats <https://golang.org/pkg/runtime/>` expvar variable. These ``memstat`` metrics are referred to as standard or default metrics and are exposed by default.

Benefits
--------
Expand Down
35 changes: 31 additions & 4 deletions gdi/monitors-network/statsd.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,37 @@ Statsd

The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the ``statsd`` monitor type to collect statsd metrics. It listens on a configured address and port to receive the statsd metrics.

This integration supports the ``Counter``, ``Timer``, ``Gauge``, and
``Set`` types, which are dispatched as the Splunk Observability Cloud
types ``counter``, ``gauge``, ``gauge``, and ``gauge`` respectively.
Statsd extensions such as tags are not supported.
This integration supports certain Stats types, which are dispatched as ``counter`` or ``gauges`` types in Splunk Observability Cloud, as displayed in the table. Statsd extensions such as tags are not supported.

.. list-table::
:widths: 50 50
:width: 100%
:header-rows: 1

-

- Statsd type
- Splunk Observability Cloud type

-

- ``Counter``
- ``counter``

-

- ``Timer``
- ``counter``

-

- ``Gauge``
- ``gauge``

-

- ``Set``
- ``gauge``

This integration is available for Kubernetes and Linux.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ You can configure two types of authentication for the Collector:
* :ref:`oauth2client-extension`
* Sigv4 extension

.. note:: For more details see :new-page:`Auth Configuration Settings https://github.com/open-telemetry/opentelemetry-collector/tree/main/config/configauth` in OTel's GitHub repo.
.. note:: For more details see :new-page:`Auth Configuration Settings <https://github.com/open-telemetry/opentelemetry-collector/tree/main/config/configauth>` in OTel's GitHub repo.

Example
=============================================================================================
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To configure gRCP clients in :ref:`exporters <otel-components-exporters>` use th

* Defaults: ``pick_first`` before version 0.103.0, ``round_robin`` for v0.103.0 or higher

* Learn more at gRCP's :new-page:`Load Balancing README https://github.com/grpc/grpc-go/blob/master/examples/features/load_balancing/README.md`.
* Learn more at gRCP's :new-page:`Load Balancing README <https://github.com/grpc/grpc-go/blob/master/examples/features/load_balancing/README.md>`.

* ``compression``

Expand Down
6 changes: 3 additions & 3 deletions gdi/opentelemetry/tags.rst
Original file line number Diff line number Diff line change
Expand Up @@ -101,14 +101,14 @@ Containers

There are numerous attributes for services running in containers, such as ``container.id``, ``container.name``, or ``container.image.name``.

Learn more in the OpenTelemetry GitHub repo at :new-page:`Container semantic conventions <https://github.com/open-telemetry/semantic-conventions/blob/main/model/resource/container.yaml>`.
Learn more in the OpenTelemetry GitHub repo at :new-page:`Container semantic conventions <https://github.com/open-telemetry/semantic-conventions/blob/main/model/container/resources.yaml>`.

Hosts
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

There are numerous attributes for services running in hosts, such as ``host.id``, ``host.name``, or ``host.arch``.

Learn more in the OpenTelemetry GitHub repo at :new-page:`Host semantic conventions <https://github.com/open-telemetry/semantic-conventions/blob/main/model/resource/host.yaml>`.
Learn more in the OpenTelemetry GitHub repo at :new-page:`Host semantic conventions <https://github.com/open-telemetry/semantic-conventions/blob/main/model/host/resources.yaml>`.

Deployment environment
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -122,7 +122,7 @@ Cloud

There are attributes that capture information for services running in public cloud environments, such ``cloud.provider``, ``cloud.account.id``, or ``cloud.region``.

Learn more in the OpenTelemetry GitHub repo at :new-page:`Cloud semantic conventions <https://github.com/open-telemetry/semantic-conventions/blob/main/model/resource/cloud.yaml>`.
Learn more in the OpenTelemetry GitHub repo at :new-page:`Cloud semantic conventions <https://github.com/open-telemetry/semantic-conventions/blob/main/model/cloud/resources.yaml>`.

.. caution:: Some cloud providers, such as GCP, define semantic conventions specific to their offering. Check Google official documentation for more information.

Expand Down
2 changes: 1 addition & 1 deletion logs/LOconnect-troubleshoot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ To limit Splunk platform indexes for Log Observer Connect users, a Splunk Enterp
1. Log in as an administrator in your Splunk platform instance.

2. Splunk Cloud Platform administrators can skip this step. If the ``indexes_list_all`` capability is not present in your Splunk Enterprise instance, create a ``[capability::indexes_list_all]`` stanza in ``authorize.conf``. Once the configuration is set in ``authorize.conf``, the ``indexes_list_all`` capability is deactivated for all roles. The administrator can then add this capability for select roles in the UI or in ``authorize.conf``.
3. Enable ``indexes_list_all`` capability for the admin role and any other roles that need to access the indexes. For more information about adding capabilities to a role, see :new-page:`Define roles on the Splunk plaftorm with capabilities <https://docs.splunk.com/Documentation/Splunk/9.0.4/Security/Rolesandcapabilities>`.
3. Enable ``indexes_list_all`` capability for the admin role and any other roles that need to access the indexes. For more information about adding capabilities to a role, see :new-page:`Define roles on the Splunk platform with capabilities <https://docs.splunk.com/Documentation/Splunk/9.0.4/Security/Rolesandcapabilities>`.

4. Go to :guilabel:`Settings > Roles` and click the name of your Log Observer Connect service account role.

Expand Down
Loading