diff --git a/docs/send-data/opentelemetry-collector/index.md b/docs/send-data/opentelemetry-collector/index.md index 697ccfd56f..9ff47e43cb 100644 --- a/docs/send-data/opentelemetry-collector/index.md +++ b/docs/send-data/opentelemetry-collector/index.md @@ -31,6 +31,24 @@ In this section, we'll introduce the following concepts:

Collect logs, metrics, and tracing data, as well as how to add configurations for the OpenTelemetry collector.

+ +
+
+ + OTel thumbnail icon +

Remote Management

+
+

Learn about remote management of OpenTelemetry collectors.

+
+
+
+
+ + OTel thumbnail icon +

View Details About an OpenTelemetry Collector

+
+

Learn how to view details about an OpenTelemetry Collector.

+
@@ -61,6 +79,12 @@ In this section, we'll introduce the following concepts: OTel thumbnail icon

Troubleshooting

Find solutions to common issues with the OpenTelemetry collector.

+
+
+
+ OTel thumbnail icon

Sumo Logic OTel

+

Understand the relationship between the Sumo Logic OpenTelemetry Collector and the OpenTelemetry upstream project.

+
@@ -68,12 +92,6 @@ In this section, we'll introduce the following concepts:

Find answers to frequently asked questions about the OpenTelemetry collector.

-
-
- OTel thumbnail icon

Sumo Logic OTel

-

Understand the relationship between the Sumo Logic OpenTelemetry Collector and the OpenTelemetry upstream project.

-
-
## Additional resources diff --git a/docs/send-data/opentelemetry-collector/view-opentelemetry-collection-page.md b/docs/send-data/opentelemetry-collector/view-opentelemetry-collection-page.md new file mode 100644 index 0000000000..9703627620 --- /dev/null +++ b/docs/send-data/opentelemetry-collector/view-opentelemetry-collection-page.md @@ -0,0 +1,40 @@ +--- +id: view-opentelemetry-collection-page +title: View Details About an OpenTelemetry Collector +description: Learn how to view details about an OpenTelemetry Collector. +--- + +import useBaseUrl from '@docusaurus/useBaseUrl'; + +To view details about an OpenTelemetry Collector: + +1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu select **Manage Data > Collection > OpenTelemetry Collector**.
[**New UI**](/docs/get-started/sumo-logic-ui). In the top menu select **Configuration**, and then under **Collection** select **OpenTelemetry Collector**. You can also click the **Go To...** menu at the top of the screen and select **OpenTelemetry Collector**.
opentelemetry-collection-page + - **Name**. Name of the OpenTelemetry Collector. + - **Health**. Displays the health status of the collector. + - **Operating System**. Displays the operating system where the collector is installed. + - **Collector Tags**. Displays the tags linked with the selected collector, which helps in searching and managing the collector. + - **Source Templates**. Shows the number of source templates linked with the selected collector. + - **IP Address**. Displays the IP address where the collector is running. + - **Log Messages (-1h)**. Displays the histogram which shows the data ingested in last one hour. + :::info + Dashed line indicates there was no data ingestion in last hour. + ::: + - **Last Modified**. Timestamp when the collector was last modified. +1. Click on the desired collector.
opentelemetry-collection-details-page + - **Basic Info** + - **Name**. Name of the OpenTelemetry Collector. + - **Collector Version**. The collector version with which the collector was created. + - **Source Templates**. Displays the number of source templte + - **Health**. Displays the health status of the collector. + - **Time Zone**. By default, time zone is set to UTC. + - **Collector Tags**. Displays the tags linked with the selected collector, which helps in searching and managing the collector. To add or edit the tags, refer to the [Collector Tags](/docs/send-data/opentelemetry-collector/remote-management/source-templates/manage-source-templates/#collector-tags). + - **Data Ingested**. Displays the histogram which shows data ingested in last hour. This histogram timeline reflects the data ingestion timestamp as closely as possible, but minor variations may occur. + :::note + If there is a mismatch between the log count in the histogram and the log search, switch the log search timestamp to *receiptTime* for accurate results. + ::: + - **System Information**. Displays the operating system, OS version, IP Address, and Host name of the user who created the collector. + - **Audit Logs**. Records the collector changes. Click on **View Details** to view the changes. + - **Collector ID**. Unique ID for the selected collector. + - **Last Modified**. Timestamp when the collector was last modified. + - **Created**. Timestamp when the collector was created. + - **Source Templates**. Displays all the source configuration linked with the collector. diff --git a/sidebars.ts b/sidebars.ts index 157e112ceb..9d8d6fedef 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -291,6 +291,7 @@ module.exports = { 'send-data/opentelemetry-collector/remote-management/troubleshooting', ], }, + 'send-data/opentelemetry-collector/view-opentelemetry-collection-page', 'send-data/opentelemetry-collector/auto-discovery', 'send-data/opentelemetry-collector/performance-benchmarks', 'send-data/opentelemetry-collector/data-transformations', diff --git a/static/img/send-data/opentelemetry-collection-details-page.png b/static/img/send-data/opentelemetry-collection-details-page.png new file mode 100644 index 0000000000..9dd9e07457 Binary files /dev/null and b/static/img/send-data/opentelemetry-collection-details-page.png differ diff --git a/static/img/send-data/opentelemetry-collection-page.png b/static/img/send-data/opentelemetry-collection-page.png new file mode 100644 index 0000000000..a6783e5c02 Binary files /dev/null and b/static/img/send-data/opentelemetry-collection-page.png differ