Skip to content

Commit 69b598d

Browse files
committed
comments incorporated
1 parent 62bce84 commit 69b598d

File tree

3 files changed

+33
-22
lines changed

3 files changed

+33
-22
lines changed

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>
Lines changed: 21 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Timestamp is the part of a log message that marks the time that an event occurre
2424
When configuring a source template, specify a custom format to parse timestamps in your log messages. 
2525

2626
:::note
27-
Currently, only `strptime` timestamp are supported in the source templates.
27+
Currently, only `strptime` timestamps are supported in the source templates.
2828
:::
2929

3030
### Timestamp considerations
@@ -41,14 +41,13 @@ If your log messages from a source contain multiple timestamps, timestamps in un
4141
OpenTelemetry Collectors can automatically parse most timestamps without any issues. However, if you see timestamp parsing issues, you can manually specify the timestamp format in the Sumo Logic UI when configuring a new Source template or editing the timestamp information for an existing Source template.
4242

4343
1. Perform one of the following steps:
44-
* If you're configuring a new Source template, proceed to step 2. Or,
45-
* To edit the timestamp settings for an existing Source template, navigate to the source template. Then click on **Edit**, to the right of the Source name and go to step 2.<br/><img src={useBaseUrl('img/send-data/source-template-edit.png')} alt="Screenshot showing the editing interface for a source template in Sumo Logic, highlighting the section for editing advanced options including timestamp settings" style={{border: '1px solid gray'}} width="600"/>
46-
1. Navigate to the **Timestamp Parsing** section.<br/><img src={useBaseUrl('img/send-data/st-timestamp-parsing.png')} alt="Screenshot of the Timestamp parsing section for logs in Sumo Logic, focusing on the timestamp format settings" style={{border: '1px solid gray'}} />
47-
1. Select **Specify the format** options,
48-
1. **Timestamp locator**. Use a [Go regular expression](https://github.com/google/re2/wiki/Syntax) to match the timestamp in your logs. Ensure the regular expression includes a named capture group called `timestamp_field`.
49-
1. **Format**. Specify the exact layout of the timestamp to be parsed. For example, `- %Y-%m-%dT%H:%M:%S.%LZ`. To learn more about the formatting rules, refer to [this guide](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/internal/coreinternal/timeutils/internal/ctimefmt/ctimefmt.go#L68).
50-
1. **Select Timezone**. Define the geographic location (timezone) to use while parsing a timestamp that does not include a timezone. The available locations depend on the local IANA Time Zone database. For example, `America/New_York`. For more examples, refer to the [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
51-
<br/><img src={useBaseUrl('img/send-data/specify-timestamp-format.png')} alt="Screenshot illustrating the process of specifying a custom timestamp format in the Sumo Logic UI" style={{border: '1px solid gray'}} width="300"/>
44+
* If you're configuring a new Source template, proceed to Step 2. Or,
45+
* To edit the timestamp settings for an existing Source template, navigate to the source template. Then click on **Edit**, to the right of the Source name and go to Step 2.<br/><img src={useBaseUrl('img/send-data/source-template-edit.png')} alt="Screenshot showing the editing interface for a source template in Sumo Logic, highlighting the section for editing advanced options including timestamp settings" style={{border: '1px solid gray'}} width="400"/>
46+
1. Navigate to the **Timestamp Parsing** section and select **Specify the format** and enter the below details:
47+
1. **Select Timezone**. Define the geographic location (time zone) to use while parsing a timestamp that does not include a time zone. The available locations depend on the local IANA Time Zone database. For example, `America/New_York`. For more examples, refer to the [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
48+
1. **Format**. Specify the exact layout of the timestamp to be parsed. For example, `- %Y-%m-%dT%H:%M:%S.%LZ`. To learn more about the formatting rules, refer to [this guide](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/internal/coreinternal/timeutils/internal/ctimefmt/ctimefmt.go#L68).
49+
1. **Timestamp locator**. Use a [Go regular expression](https://github.com/google/re2/wiki/Syntax) to match the timestamp in your logs. Ensure the regular expression includes a named capture group called `timestamp_field`.<br/><img src={useBaseUrl('img/send-data/st-timestamp-parsing.png')} alt="Screenshot of the Timestamp parsing section for logs in Sumo Logic, focusing on the timestamp format settings" style={{border: '1px solid gray'}} width="400" />
50+
5251

5352
### Using _format for troubleshooting
5453

@@ -87,7 +86,7 @@ The result would look like this: <br/><img src={useBaseUrl('img/send-data/format
8786

8887
### Timestamp format examples
8988

90-
The following conventions are some example of the supported formats for `strptime` in OpenTelemetry collector:
89+
The following conventions are some examples of the supported formats for `strptime` in OpenTelemetry collector:
9190

9291
| `strptime` Format | Example |
9392
|-------------------|---------|
@@ -139,15 +138,15 @@ The following conventions are some example of the supported formats for `strptim
139138
| `%q/%g/%Y %l:%M:%S %p:%f` | 8/5/2023 3:31:18 AM:234 |
140139
| `%q/%d/%Y %I:%M:%S %p` | 9/28/2023 2:23:15 PM |
141140

142-
### Timezone considerations
141+
### Time zone considerations
143142

144-
The following considerations apply to timezones:
143+
The following considerations apply to time zones:
145144

146-
* We highly recommend that the timezone be set explicitly on any source template where the logs does not have a timezone available. Sumo Logic always attempts to determine the timezone for the Source. However, if that is not possible, the timezone will revert to UTC. In these cases, the timezone will be incorrect, and that could significantly affect forensic analysis and reporting.
145+
We highly recommend that the time zone be set explicitly on any source template where the logs does not have a time zone available. Sumo Logic always attempts to determine the time zone for the Source. However, if that is not possible, the time zone will revert to UTC. In these cases, the time zone will be incorrect, and that could significantly affect forensic analysis and reporting.
147146

148-
### Default timezone
147+
### Default time zone
149148

150-
By default, we use the timezone from your web browser set by the operating system to display hours and minutes everywhere in our user interface. You can change the default timezone that the user interface displays by adjusting the **Default Timezone** setting on the **Preferences** page. This option overrides the timezone from your web browser, and changes how hours and minutes are displayed in the UI. But this is a personal setting, and does not change the timezone for anyone else in your organization.
149+
By default, we use the time zone from your web browser set by the operating system to display hours and minutes everywhere in our user interface. You can change the default time zone that the user interface displays by adjusting the **Default time zone** setting on the **Preferences** page. This option overrides the time zone from your web browser, and changes how hours and minutes are displayed in the UI. But this is a personal setting, and does not change the time zone for anyone else in your organization.
151150

152151
UI elements that are affected by this setting include:
153152

@@ -156,18 +155,18 @@ UI elements that are affected by this setting include:
156155
- Dashboards
157156
- Anomaly Detection
158157

159-
Changing the **Default Timezone** setting affects how the UI displays messages, but not the actual timestamp in the log message.
158+
Changing the **Default time zone** setting affects how the UI displays messages, but not the actual timestamp in the log message.
160159

161-
For example, the following screenshot shows the timezone set to **PST** in the UI, in the **Time** column. The logs were collected from a system that was also configured to use the **PST** timezone, which is displayed in the timestamp of the **Message** column. The timestamps in both columns match as they are set to the same timezone.
160+
For example, the following screenshot shows the time zone set to **PST** in the UI, in the **Time** column. The logs were collected from a system that was also configured to use the **PST** time zone, which is displayed in the timestamp of the **Message** column. The timestamps in both columns match as they are set to the same time zone.
162161

163162
<img src={useBaseUrl('img/send-data/timezone_PST.png')} alt="Screenshot demonstrating log timestamps displayed in Pacific Standard Time (PST) in the Sumo Logic UI" width="500" />
164163

165-
The next screenshot shows the same search result after changing the Default Timezone setting to UTC. Now the Time column is displayed in UTC, while the Message column retains the original timestamp, in PST.
164+
The next screenshot shows the same search result after changing the Default Time zone setting to UTC. Now the Time column is displayed in UTC, while the Message column retains the original timestamp, in PST.
166165

167-
<img src={useBaseUrl('img/send-data/timezone_UTC.png')} alt="Screenshot showing the same log timestamps now displayed in Coordinated Universal Time (UTC) after changing the default timezone setting" width="500"/>
166+
<img src={useBaseUrl('img/send-data/timezone_UTC.png')} alt="Screenshot showing the same log timestamps now displayed in Coordinated Universal Time (UTC) after changing the default time zone setting" width="500"/>
168167

169-
In another example, if your timezone is set to **UTC**, and you share a Dashboard with another user who has their tim zone set to **PST**, what will they see?
168+
In another example, if your time zone is set to **UTC**, and you share a dashboard with another user who has their tim zone set to **PST**, what will they see?
170169

171-
They will see the same data, just displayed using their custom set timezone. For example, if you have a Panel that uses a time series, the timeline on the X axis of your chart is displayed in your timezone**UTC**. The other user will see the timeline on the X axis displayed in their timezone**PST**. But the data displayed in the chart is exactly the same.
170+
They will see the same data, just displayed using their custom set time zone. For example, if you have a Panel that uses a time series, the timeline on the X axis of your chart is displayed in your time zone**UTC**. The other user will see the timeline on the X axis displayed in their time zone**PST**. But the data displayed in the chart is exactly the same.
172171

173-
<img src={useBaseUrl('img/send-data/timezone_dashboards_compare.png')} alt="Screenshot comparing how dashboards display timezones differently for users with custom timezone settings, highlighting the same data shown in different timezones." width="600"/>
172+
<img src={useBaseUrl('img/send-data/timezone_dashboards_compare.png')} alt="Screenshot comparing how dashboards display time zones differently for users with custom time zone settings, highlighting the same data shown in different time zones." width="600"/>

sidebars.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,7 @@ module.exports = {
274274
]
275275
},
276276
'send-data/opentelemetry-collector/remote-management/source-templates/st-with-secrets',
277+
'send-data/opentelemetry-collector/remote-management/source-templates/otrm-time-reference',
277278
],
278279
},
279280
{

0 commit comments

Comments
 (0)