Skip to content

Commit b348bea

Browse files
sumoanemaJV0812jpipkin1kimsauce
authored
Source template feature for Timestamp parsing (#5552)
* Source template feature for Timestamp parsing * Update otrmTimestampParsing.md * Apply suggestions from code review Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * comments incorporated * Fix broken links * Minor change to link text * Replace otelcol timestamp /reuse reference (#5566) * Replace otelcol timestamp /reuse reference * cross-references * Update docs/send-data/opentelemetry-collector/remote-management/source-templates/postgresql/index.md * Update docs/send-data/opentelemetry-collector/remote-management/source-templates/rabbitmq/index.md * Update docs/send-data/opentelemetry-collector/remote-management/source-templates/redis/index.md * Update docs/send-data/opentelemetry-collector/remote-management/source-templates/otrm-time-reference.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Update docs/reuse/apps/opentelemetry/timestamp-parsing.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> --------- Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Fixes from the comments PR:5566 * minor fixes --------- Co-authored-by: Jagadisha V <[email protected]> Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> Co-authored-by: Jagadisha V <[email protected]> Co-authored-by: Kim (Sumo Logic) <[email protected]>
1 parent a1e832e commit b348bea

File tree

18 files changed

+216
-30
lines changed

18 files changed

+216
-30
lines changed

docs/reuse/apps/opentelemetry/logs-advance-option-otel.md

Lines changed: 0 additions & 5 deletions
This file was deleted.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
**Timestamp Parsing**. You can configure timestamp parsing for logs ingested using this source template. For more information, see [Timestamps, Time Zones, Time Ranges, and Date Formats for the OpenTelemetry Collector](/docs/send-data/opentelemetry-collector/remote-management/source-templates/otrm-time-reference).

docs/send-data/opentelemetry-collector/remote-management/source-templates/apache/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,9 @@ In this step, you will configure the yaml required for Apache Collection. Below
7777
- **Error file log path**. Enter the path to the error log file for your Apache instance.
7878
- **Fields/Metadata**. You can provide any customer fields to be tagged with the data collected. By default, sumo tags `_sourceCategory` with the value otel/apache user needs to provide the value for `webengine.cluster.name`.
7979

80-
import OtelLogAdvanceOption from '../../../../../reuse/apps/opentelemetry/logs-advance-option-otel.md';
80+
import TimestampParsing from '../../../../../reuse/apps/opentelemetry/timestamp-parsing.md';
8181

82-
<OtelLogAdvanceOption/>
82+
<TimestampParsing/>
8383

8484
**Processing Rules**. You can add **processing rules** for logs/metrics collected. To learn more, refer to [Processing Rules](../../processing-rules/index.md).
8585

docs/send-data/opentelemetry-collector/remote-management/source-templates/docker/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,9 @@ In this step, you will configure the yaml required for Docker Collection. Below
7777
- **Excluded Image List**. A list of strings, [regexes](https://golang.org/pkg/regexp/), or [globs](https://github.com/gobwas/glob) whose referent container image names will not be among the queried containers for scrapping metrics. Learn more about [*excluded_images*](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/dockerstatsreceiver/README.md#configuration).
7878
- **Fields/Metadata**. You can provide any customer fields to be tagged with the data collected. By default, Sumo Logic tags `_sourceCategory` with the value otel/docker.
7979

80-
import OtelLogAdvanceOption from '../../../../../reuse/apps/opentelemetry/logs-advance-option-otel.md';
80+
import TimestampParsing from '../../../../../reuse/apps/opentelemetry/timestamp-parsing.md';
8181

82-
<OtelLogAdvanceOption/>
82+
<TimestampParsing/>
8383

8484
**Processing Rules**. You can add **processing rules** for logs/metrics collected. To learn more, refer to [Processing Rules](../../processing-rules/index.md).
8585

docs/send-data/opentelemetry-collector/remote-management/source-templates/elasticsearch/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,16 +71,16 @@ import CollectorInstallation from '../../../../../reuse/apps/opentelemetry/colle
7171
In this step, you will configure the yaml required for Elasticsearch collection. Below are the inputs required for configuration:
7272

7373
- **Name**. Name of the source template.
74-
- **Description**. Description for the source template.
74+
- **Description**. Description for the source template.
7575
- **Log Filepath**. Location where the Elasticsearch logs are logged. Please refer to your elasticsearch.conf file.
7676
- **Endpoint**. Enter the url of the server you need to monitor. (default: `localhost:9200`).
7777
- **Username**. Enter the Elasticsearch username.
7878
- **Password Environment Variable Name**. Enter the Elasticsearch password environment variable name.
7979
- **Fields/Metadata**. You can provide any customer fields to be tagged with the data collected. By default, Sumo Logic tags `_sourceCategory` with the value otel/elasticsearch user needs to provide the value for `db.cluster.name`.
8080

81-
import OtelLogAdvanceOption from '../../../../../reuse/apps/opentelemetry/logs-advance-option-otel.md';
81+
import TimestampParsing from '../../../../../reuse/apps/opentelemetry/timestamp-parsing.md';
8282

83-
<OtelLogAdvanceOption/>
83+
<TimestampParsing/>
8484

8585
**Processing Rules**. You can add **processing rules** for logs/metrics collected. To learn more, refer to [Processing Rules](../../processing-rules/index.md).
8686

@@ -92,4 +92,4 @@ import DataConfiguration from '../../../../../reuse/apps/opentelemetry/data-conf
9292

9393
:::info
9494
Refer to the [changelog](changelog.md) for information on periodic updates to this source template.
95-
:::
95+
:::

docs/send-data/opentelemetry-collector/remote-management/source-templates/index.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,4 +86,15 @@ In this section, we'll show you how to set up source templates for the following
8686
<a href="/docs/send-data/opentelemetry-collector/remote-management/source-templates/windows"><img src={useBaseUrl('img/integrations/microsoft-azure/windows.png')} alt="Thumbnail icon" width="30"/><h4>Windows</h4></a><p>Learn how to configure our OTel Windows source template.</p>
8787
</div>
8888
</div>
89+
90+
<div className="box smallbox card">
91+
<div className="container">
92+
<a href="/docs/send-data/opentelemetry-collector/remote-management/source-templates/otrm-time-reference"><img src={useBaseUrl('img/send-data/otel-color.svg')} alt="Thumbnail icon" width="30"/><h4>Timestamps, Time Zones, and Date Formats</h4></a><p>Learn how Sumo Logic manages timestamps, time zones, and dates.</p>
93+
</div>
94+
</div>
95+
<div className="box smallbox card">
96+
<div className="container">
97+
<a href="/docs/send-data/opentelemetry-collector/remote-management/source-templates/st-with-secrets"><img src={useBaseUrl('img/send-data/otel-color.svg')} alt="Thumbnail icon" width="30"/><h4>Setting Environment Variables with Secret Values for Source Templates</h4></a><p>Learn about the steps for setting environment variable with secret value.</p>
98+
</div>
99+
</div>
89100
</div>

docs/send-data/opentelemetry-collector/remote-management/source-templates/kafka/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ In this step, you will configure the yaml required for Kafka collection. Below a
6868
- **Endpoint**. The URL of the broker endpoint (default: `localhost:9092`).
6969
- **Fields/Metadata**. You can provide any customer fields to be tagged with the data collected. By default, Sumo Logic tags `_sourceCategory` with the value otel/kafka user needs to provide the value for `webengine.cluster.name`.
7070

71-
import OtelLogAdvanceOption from '../../../../../reuse/apps/opentelemetry/logs-advance-option-otel.md';
71+
import TimestampParsing from '../../../../../reuse/apps/opentelemetry/timestamp-parsing.md';
7272

73-
<OtelLogAdvanceOption/>
73+
<TimestampParsing/>
7474

7575
**Processing Rules**. You can add **processing rules** for logs/metrics collected. To learn more, refer to [Processing Rules](../../processing-rules/index.md).
7676

docs/send-data/opentelemetry-collector/remote-management/source-templates/localfile/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,9 @@ In this step, you will configure the yaml required for Local File collection. Be
5555
- **Collection should begin from**. Defines where will the collection of the logs start from. Possible values are "End of File" and "Beginning of File".
5656
- **Detect messages spanning multiple lines**. You can enable this option when dealing with logs which span over multiple lines. On enabling this option you will need to specify **Boundary regex location** where you can specify if the expression defines end or start of the log line and **Expression to match message boundary** where you will define the expression.
5757

58-
import OtelLogAdvanceOption from '../../../../../reuse/apps/opentelemetry/logs-advance-option-otel.md';
58+
import TimestampParsing from '../../../../../reuse/apps/opentelemetry/timestamp-parsing.md';
5959

60-
<OtelLogAdvanceOption/>
60+
<TimestampParsing/>
6161

6262
**Processing Rules**. You can add processing rules for logs collected. To learn more, refer to [Processing Rules](../../processing-rules/index.md).
6363

docs/send-data/opentelemetry-collector/remote-management/source-templates/mysql/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,17 +80,17 @@ import CollectorInstallation from '../../../../../reuse/apps/opentelemetry/colle
8080
In this step, you will configure the yaml required for MySQL collection. Below are the inputs required for configuration:
8181

8282
- **Name**. Name of the source template.
83-
- **Description**. Description for the source template.
83+
- **Description**. Description for the source template.
8484
- **Error log path**. Location where the SQL Errors are logged. Please refer to your my.cnf file.
8585
- **Slow Transaction log file path (optional)**. Location where the Slow SQL transactions are logged. Please refer to your my.cnf file.
8686
- **Endpoint**. The URL of the MySQL endpoint (default: `localhost:3306`).
8787
- **Username**. Enter the MySQL username.
8888
- **Password Environment Variable Name**. Enter the MySQL password environment variable name.
8989
- **Fields/Metadata**. You can provide any customer fields to be tagged with the data collected. By default, Sumo Logic tags `_sourceCategory` with the value otel/mysql user needs to provide the value for `db.cluster.name`.
9090

91-
import OtelLogAdvanceOption from '../../../../../reuse/apps/opentelemetry/logs-advance-option-otel.md';
91+
import TimestampParsing from '../../../../../reuse/apps/opentelemetry/timestamp-parsing.md';
9292

93-
<OtelLogAdvanceOption/>
93+
<TimestampParsing/>
9494

9595
**Processing Rules**. You can add **processing rules** for logs/metrics collected. To learn more, refer to [Processing Rules](../../processing-rules/index.md).
9696

@@ -102,4 +102,4 @@ import DataConfiguration from '../../../../../reuse/apps/opentelemetry/data-conf
102102

103103
:::info
104104
Refer to the [changelog](changelog.md) for information on periodic updates to this source template.
105-
:::
105+
:::

docs/send-data/opentelemetry-collector/remote-management/source-templates/nginx/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,9 @@ In this step, you will configure the yaml required for Nginx collection. Below a
7676
- **Path to Nginx error Log file**. Enter the path to the error log file for your Nginx instance.
7777
- **Fields/Metadata**. You can provide any customer fields to be tagged with the data collected. By default sumo tags `_sourceCategory` with the value otel/nginx user needs to provide the value for `webengine.cluster.name`.
7878

79-
import OtelLogAdvanceOption from '../../../../../reuse/apps/opentelemetry/logs-advance-option-otel.md';
79+
import TimestampParsing from '../../../../../reuse/apps/opentelemetry/timestamp-parsing.md';
8080

81-
<OtelLogAdvanceOption/>
81+
<TimestampParsing/>
8282

8383
**Processing Rules**. You can add **processing rules** for logs/metrics collected. To learn more, refer to [Processing Rules](../../processing-rules/index.md).
8484

0 commit comments

Comments
 (0)