Skip to content

Commit aa424b0

Browse files
JV0812jpipkin1Damotharan-A
authored
View Details About a OpenTelemetry Collector - Doc created (#5419)
* iew Details About a OpenTelemetry Collector - Doc created * Update docs/send-data/opentelemetry-collector/view-opentelemetry-collection-page.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Update docs/send-data/opentelemetry-collector/view-opentelemetry-collection-page.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Update docs/send-data/opentelemetry-collector/view-opentelemetry-collection-page.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * minot fix * Add index page entry * Update docs/send-data/opentelemetry-collector/view-opentelemetry-collection-page.md Co-authored-by: Damotharan A <[email protected]> * Update view-opentelemetry-collection-page.md * Update view-opentelemetry-collection-page.md * Update docs/send-data/opentelemetry-collector/view-opentelemetry-collection-page.md * incorporated minor comments --------- Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> Co-authored-by: Damotharan A <[email protected]>
1 parent 0693458 commit aa424b0

File tree

5 files changed

+65
-6
lines changed

5 files changed

+65
-6
lines changed

docs/send-data/opentelemetry-collector/index.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,24 @@ In this section, we'll introduce the following concepts:
3131
</a>
3232
<p>Collect logs, metrics, and tracing data, as well as how to add configurations for the OpenTelemetry collector.</p>
3333
</div>
34+
</div>
35+
<div className="box smallbox card">
36+
<div className="container">
37+
<a href="/docs/send-data/opentelemetry-collector/remote-management/">
38+
<img src={useBaseUrl('img/send-data/otel-color.svg')} alt="OTel thumbnail icon" width="25"/>
39+
<h4>Remote Management</h4>
40+
</a>
41+
<p>Learn about remote management of OpenTelemetry collectors.</p>
42+
</div>
43+
</div>
44+
<div className="box smallbox card">
45+
<div className="container">
46+
<a href="/docs/send-data/opentelemetry-collector/view-opentelemetry-collection-page">
47+
<img src={useBaseUrl('img/send-data/otel-color.svg')} alt="OTel thumbnail icon" width="25"/>
48+
<h4>View Details About an OpenTelemetry Collector</h4>
49+
</a>
50+
<p>Learn how to view details about an OpenTelemetry Collector.</p>
51+
</div>
3452
</div>
3553
<div className="box smallbox card">
3654
<div className="container">
@@ -61,19 +79,19 @@ In this section, we'll introduce the following concepts:
6179
<a href="/docs/send-data/opentelemetry-collector/troubleshooting"><img src={useBaseUrl('img/send-data/otel-color.svg')} alt="OTel thumbnail icon" width="25"/><h4>Troubleshooting</h4></a>
6280
<p>Find solutions to common issues with the OpenTelemetry collector.</p>
6381
</div>
82+
</div>
83+
<div className="box smallbox card">
84+
<div className="container">
85+
<a href="/docs/send-data/opentelemetry-collector/sumo-logic-opentelemetry-vs-opentelemetry-upstream-relationship"><img src={useBaseUrl('img/send-data/otel-color.svg')} alt="OTel thumbnail icon" width="25"/><h4>Sumo Logic OTel</h4></a>
86+
<p>Understand the relationship between the Sumo Logic OpenTelemetry Collector and the OpenTelemetry upstream project.</p>
87+
</div>
6488
</div>
6589
<div className="box smallbox card">
6690
<div className="container">
6791
<a href="/docs/send-data/opentelemetry-collector/faq"><img src={useBaseUrl('img/send-data/otel-color.svg')} alt="OTel thumbnail icon" width="25"/><h4>FAQ</h4></a>
6892
<p>Find answers to frequently asked questions about the OpenTelemetry collector.</p>
6993
</div>
7094
</div>
71-
<div className="box smallbox card">
72-
<div className="container">
73-
<a href="/docs/send-data/opentelemetry-collector/sumo-logic-opentelemetry-vs-opentelemetry-upstream-relationship"><img src={useBaseUrl('img/send-data/otel-color.svg')} alt="OTel thumbnail icon" width="25"/><h4>Sumo Logic OTel</h4></a>
74-
<p>Understand the relationship between the Sumo Logic OpenTelemetry Collector and the OpenTelemetry upstream project.</p>
75-
</div>
76-
</div>
7795
</div>
7896

7997
## Additional resources
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
id: view-opentelemetry-collection-page
3+
title: View Details About an OpenTelemetry Collector
4+
description: Learn how to view details about an OpenTelemetry Collector.
5+
---
6+
7+
import useBaseUrl from '@docusaurus/useBaseUrl';
8+
9+
To view details about an OpenTelemetry Collector:
10+
11+
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu select **Manage Data > Collection > OpenTelemetry Collector**. <br/>[**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**. <br/><img src={useBaseUrl('img/send-data/opentelemetry-collection-page.png')} alt="opentelemetry-collection-page" style={{border:'1px solid gray'}} width="1000"/>
12+
- **Name**. Name of the OpenTelemetry Collector.
13+
- **Health**. Displays the health status of the collector.
14+
- **Operating System**. Displays the operating system where the collector is installed.
15+
- **Collector Tags**. Displays the tags linked with the selected collector, which helps in searching and managing the collector.
16+
- **Source Templates**. Shows the number of source templates linked with the selected collector.
17+
- **IP Address**. Displays the IP address where the collector is running.
18+
- **Log Messages (-1h)**. Displays the histogram which shows the data ingested in last one hour.
19+
:::info
20+
Dashed line indicates there was no data ingestion in last hour.
21+
:::
22+
- **Last Modified**. Timestamp when the collector was last modified.
23+
1. Click on the desired collector.<br/><img src={useBaseUrl('img/send-data/opentelemetry-collection-details-page.png')} alt="opentelemetry-collection-details-page" style={{border:'1px solid gray'}} width="400"/>
24+
- **Basic Info**
25+
- **Name**. Name of the OpenTelemetry Collector.
26+
- **Collector Version**. The collector version with which the collector was created.
27+
- **Source Templates**. Displays the number of source templte
28+
- **Health**. Displays the health status of the collector.
29+
- **Time Zone**. By default, time zone is set to UTC.
30+
- **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).
31+
- **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.
32+
:::note
33+
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.
34+
:::
35+
- **System Information**. Displays the operating system, OS version, IP Address, and Host name of the user who created the collector.
36+
- **Audit Logs**. Records the collector changes. Click on **View Details** to view the changes.
37+
- **Collector ID**. Unique ID for the selected collector.
38+
- **Last Modified**. Timestamp when the collector was last modified.
39+
- **Created**. Timestamp when the collector was created.
40+
- **Source Templates**. Displays all the source configuration linked with the collector.

sidebars.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -291,6 +291,7 @@ module.exports = {
291291
'send-data/opentelemetry-collector/remote-management/troubleshooting',
292292
],
293293
},
294+
'send-data/opentelemetry-collector/view-opentelemetry-collection-page',
294295
'send-data/opentelemetry-collector/auto-discovery',
295296
'send-data/opentelemetry-collector/performance-benchmarks',
296297
'send-data/opentelemetry-collector/data-transformations',
100 KB
Loading
291 KB
Loading

0 commit comments

Comments
 (0)