Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OTel Timestamps Date Formats docs added #4758

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

JV0812
Copy link
Collaborator

@JV0812 JV0812 commented Nov 14, 2024

Purpose of this pull request

This pull request is to create OTel Timestamps Date Formats docs.

Select the type of change

  • Minor Changes - Typos, formatting, slight revisions
  • Update Content - Revisions, updating sections
  • New Content - New features, sections, pages, tutorials
  • Site and Tools - .clabot, version updates, maintenance, dependencies, new packages for the site (Docusaurus, Gatsby, React, etc.)

Ticket (if applicable)

Create a page with "Supported timestamp and date format"

@JV0812 JV0812 requested review from kimsauce, jpipkin1, mafsumo and a team as code owners November 14, 2024 11:56
@cla-bot cla-bot bot added the cla-signed Contributor approved, listed in .clabot file label Nov 14, 2024
@JV0812 JV0812 self-assigned this Nov 14, 2024
@JV0812 JV0812 marked this pull request as draft November 14, 2024 11:56
@JV0812 JV0812 added the do-not-merge Pull requests that should not be merged label Nov 14, 2024
@JV0812 JV0812 marked this pull request as ready for review November 15, 2024 03:56
@jpipkin1 jpipkin1 requested a review from amee-sumo as a code owner December 4, 2024 18:09
Copy link
Collaborator

@jpipkin1 jpipkin1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved, @JV0812. I'm sorry I missed seeing this one earlier!

Comment on lines +10 to +11
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if you need this since there are no tabs

import TabItem from '@theme/TabItem';
import useBaseUrl from '@docusaurus/useBaseUrl';

We support several options for timestamps. When collecting log data, the timestamp attached to messages is vital, both for the integrity of the data in your account, and for accurate query results.
Copy link
Collaborator

@kimsauce kimsauce Dec 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd ask a SME how this is different from the info here https://help.sumologic.com/docs/send-data/reference-information/time-reference/

We support several options for timestamps. When collecting log data, the timestamp attached to messages is vital, both for the integrity of the data in your account, and for accurate query results.

Because of the importance of timestamps, Sumo Logic indexes the timestamp of each message, making sure that data relevant to a query’s time range is returned properly in search results, which allows you to reconstruct a correct event timeline.

Copy link
Collaborator

@kimsauce kimsauce Dec 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd also add a note.... something like

For foundational details on how Sumo Logic recognizes and processes timestamps, time zones, time ranges, and dates, refer to the [Time Reference documentation](https://help.sumologic.com/docs/send-data/reference-information/time-reference).

| `%m%d_%H:%M:%S` | 0423_11:42:35 |
| `%m%d_%H:%M:%S.%f` | 0423_11:42:35.883 |
| `%q/%g/%Y %l:%M:%S %p:%f` | 8/5/2023 3:31:18 AM:234 |
| `%q/%d/%Y %I:%M:%S %p` | 9/28/2023 2:23:15 PM |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd add an example configuration at the end of the doc that shows how a timestamp is used (a SME could help provide an ex.)

Copy link
Collaborator

@kimsauce kimsauce left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few suggestions!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-signed Contributor approved, listed in .clabot file do-not-merge Pull requests that should not be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants