Add documentation for Simple Schema #2940

ariamarble · 2023-02-16T19:51:30Z

Description

Adds documentation for Simple Schema for Observability in OpenSearch.

Issues Resolved

fixes #2655

Checklist

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: ariamarble <[email protected]>

ariamarble · 2023-02-16T19:52:53Z

Creating placeholder PR with page framework. Content still in progress.

hdhalter · 2023-02-17T17:26:17Z

Hi @ariamarble - the PR is not linking back to the issue. Can you please try adding one of these keywords before the issue number?
close
closes
closed
fix
fixes
fixed
resolve
resolves
resolved
Thanks!

Signed-off-by: ariamarble <[email protected]>

ariamarble · 2023-02-20T05:07:12Z

@YANG-DB can you review this PR for technical accuracy?

YANG-DB · 2023-02-21T04:15:27Z

in addition I dont see how the image has anything todo with the text ?

_observing-your-data/sso.md

Signed-off-by: ariamarble <[email protected]>

vagimeli

@ariamarble I made some comments that should be quick to address. Reach out if clarifications are needed.

_observing-your-data/sso.md

carolxob

LGTM with one minor suggestion in addition to @vagimeli 's comments.

Co-authored-by: Caroline <[email protected]>

Signed-off-by: ariamarble <[email protected]>

natebower

@ariamarble Please see my comments and changes and let me know if you have any questions. Once you've addressed my comments, I'll take another look and approve. Thanks!

_observing-your-data/sso.md

Co-authored-by: Nathan Bower <[email protected]>

Signed-off-by: ariamarble <[email protected]>

natebower

@ariamarble A few more comments and changes. Let me know once you've addressed this set and I'll review again.

_observing-your-data/sso.md

Co-authored-by: Nathan Bower <[email protected]>

Signed-off-by: ariamarble <[email protected]>

natebower

LGTM

hdhalter · 2023-02-22T19:48:21Z

@ariamarble - please make sure to change the PR name so it is meaningful in the documentation release notes. Thanks!

YANG-DB · 2023-02-24T22:57:56Z

_observing-your-data/sso.md

+Introduced 2.6
+{: .label .label-purple }
+
+OpenSearch 2.6 introduced a standardization for conforming to a common and unified observability schema: Simple Schema for Observability (SSO). [Observability]({{site.url}}{{site.baseurl}}/observing-your-data/index/) is a collection of plugins and applications that let you visualize data-driven events by using Piped Processing Language (PPL) to explore and query data stored in OpenSearch.


data-driven events -> data-driven-signals

YANG-DB · 2023-02-24T22:59:37Z

_observing-your-data/sso.md

+Introduced 2.6
+{: .label .label-purple }
+
+OpenSearch 2.6 introduced a standardization for conforming to a common and unified observability schema: Simple Schema for Observability (SSO). [Observability]({{site.url}}{{site.baseurl}}/observing-your-data/index/) is a collection of plugins and applications that let you visualize data-driven events by using Piped Processing Language (PPL) to explore and query data stored in OpenSearch.


Piped Processing Language (PPL) -> using PPL and DQK (for standard visualizations)

YANG-DB · 2023-02-24T23:01:46Z

_observing-your-data/sso.md

+
+Data Prepper conforms to the SSO schema for metrics and will gradually support traces and logs.
+
+Data Prepper's [trace mapping]({{site.url}}{{site.baseurl}}/data-prepper/common-use-cases/trace-analytics/) currently provides `service-map` data in a different way than SSO traces. To make the trace mapping compatible with Observability, it will be integrated with the SSO traces schema and will introduce `service-map` as an enriched field.


in a different way than SSO traces. -> in addition and thus enriching the standard trace signal with additional calculated field.

anirudha · 2023-02-24T23:06:35Z

_observing-your-data/sso.md

+
+With the schema in place, Observability tools can ingest, automatically extract, and aggregate data and create custom dashboards, making it easier to understand the system at a higher level.
+
+SSO is inspired by both [OpenTelemetry](https://opentelemetry.io/docs/) and the Elastic Common Schema (ECS) and uses Amazon Elastic Container Service ([Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_cwe_events.html)) event logs and OpenTelemetry metadata.


why are we talking about amazon ecs

Add documentation for SSO

9fda5eb

Signed-off-by: ariamarble <[email protected]>

ariamarble requested a review from a team as a code owner February 16, 2023 19:51

ariamarble self-assigned this Feb 16, 2023

ariamarble added 2 - In progress Issue/PR: The issue or PR is in progress. observability labels Feb 16, 2023

added content

ca36c88

Signed-off-by: ariamarble <[email protected]>

ariamarble added 3 - Tech review PR: Tech review in progress and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Feb 20, 2023

ariamarble mentioned this pull request Feb 20, 2023

[DOC] Simple Schema for Observability #2655

Closed

4 tasks

ariamarble added the release-notes PR: Include this PR in the automated release notes label Feb 20, 2023

YANG-DB suggested changes Feb 21, 2023

View reviewed changes

ariamarble added 2 - In progress Issue/PR: The issue or PR is in progress. and removed 3 - Tech review PR: Tech review in progress labels Feb 21, 2023

ariamarble added this to the v2.6 milestone Feb 21, 2023

technical review changes

6ddedd5

Signed-off-by: ariamarble <[email protected]>

ariamarble added 4 - Doc review PR: Doc review in progress and removed 2 - In progress Issue/PR: The issue or PR is in progress. labels Feb 21, 2023

vagimeli approved these changes Feb 21, 2023

View reviewed changes

carolxob self-requested a review February 21, 2023 19:54

carolxob reviewed Feb 21, 2023

View reviewed changes

_observing-your-data/sso.md Outdated Show resolved Hide resolved

carolxob approved these changes Feb 21, 2023

View reviewed changes

ariamarble and others added 2 commits February 21, 2023 14:44

Apply suggestions from doc review

66a4b5b

Co-authored-by: Caroline <[email protected]>

Made further doc review changes

eef1098

Signed-off-by: ariamarble <[email protected]>

ariamarble added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Feb 21, 2023

natebower requested changes Feb 22, 2023

View reviewed changes

natebower removed the 5 - Editorial review PR: Editorial review in progress label Feb 22, 2023

ariamarble and others added 2 commits February 22, 2023 08:49

Apply suggestions from editorial review

658ecb4

Co-authored-by: Nathan Bower <[email protected]>

Made editorial changes

ffb12cc

Signed-off-by: ariamarble <[email protected]>

natebower requested changes Feb 22, 2023

View reviewed changes

ariamarble and others added 4 commits February 22, 2023 10:24

Apply further suggestions from editorial review

fb3393b

Co-authored-by: Nathan Bower <[email protected]>

case changing

d6fd575

Signed-off-by: ariamarble <[email protected]>

sentence re-write

bccdd0e

Signed-off-by: ariamarble <[email protected]>

quick link fix

0241c27

Signed-off-by: ariamarble <[email protected]>

natebower approved these changes Feb 22, 2023

View reviewed changes

ariamarble merged commit 9052c45 into main Feb 22, 2023

ariamarble added the Closed - Complete Issue: Work is done and associated PRs closed label Feb 22, 2023

YANG-DB reviewed Feb 24, 2023

View reviewed changes

anirudha reviewed Feb 24, 2023

View reviewed changes

hdhalter added the v2.6.0 label Feb 28, 2023

ariamarble changed the title ~~Add documentation for SSO~~ Add documentation for Simple Schema Feb 28, 2023

hdhalter deleted the issue2655 branch March 28, 2024 21:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation for Simple Schema #2940

Add documentation for Simple Schema #2940

ariamarble commented Feb 16, 2023 •

edited

Loading

ariamarble commented Feb 16, 2023

hdhalter commented Feb 17, 2023

ariamarble commented Feb 20, 2023

YANG-DB commented Feb 21, 2023

vagimeli left a comment

carolxob left a comment

natebower left a comment

natebower left a comment

natebower left a comment

hdhalter commented Feb 22, 2023

YANG-DB Feb 24, 2023

YANG-DB Feb 24, 2023

YANG-DB Feb 24, 2023

anirudha Feb 24, 2023


		Data Prepper conforms to the SSO schema for metrics and will gradually support traces and logs.

		Data Prepper's [trace mapping]({{site.url}}{{site.baseurl}}/data-prepper/common-use-cases/trace-analytics/) currently provides `service-map` data in a different way than SSO traces. To make the trace mapping compatible with Observability, it will be integrated with the SSO traces schema and will introduce `service-map` as an enriched field.


		With the schema in place, Observability tools can ingest, automatically extract, and aggregate data and create custom dashboards, making it easier to understand the system at a higher level.

		SSO is inspired by both [OpenTelemetry](https://opentelemetry.io/docs/) and the Elastic Common Schema (ECS) and uses Amazon Elastic Container Service ([Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_cwe_events.html)) event logs and OpenTelemetry metadata.

Add documentation for Simple Schema #2940

Add documentation for Simple Schema #2940

Conversation

ariamarble commented Feb 16, 2023 • edited Loading

Description

Issues Resolved

Checklist

ariamarble commented Feb 16, 2023

hdhalter commented Feb 17, 2023

ariamarble commented Feb 20, 2023

YANG-DB commented Feb 21, 2023

vagimeli left a comment

Choose a reason for hiding this comment

carolxob left a comment

Choose a reason for hiding this comment

natebower left a comment

Choose a reason for hiding this comment

natebower left a comment

Choose a reason for hiding this comment

natebower left a comment

Choose a reason for hiding this comment

hdhalter commented Feb 22, 2023

YANG-DB Feb 24, 2023

Choose a reason for hiding this comment

YANG-DB Feb 24, 2023

Choose a reason for hiding this comment

YANG-DB Feb 24, 2023

Choose a reason for hiding this comment

anirudha Feb 24, 2023

Choose a reason for hiding this comment

ariamarble commented Feb 16, 2023 •

edited

Loading