-
Notifications
You must be signed in to change notification settings - Fork 506
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
Add documentation for Simple Schema #2940
Changes from all commits
9fda5eb
ca36c88
6ddedd5
66a4b5b
eef1098
658ecb4
ffb12cc
fb3393b
d6fd575
bccdd0e
0241c27
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
layout: default | ||
title: Simple Schema for Observability | ||
nav_order: 120 | ||
--- | ||
|
||
# Simple Schema for Observability | ||
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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Piped Processing Language (PPL) -> using PPL and DQK (for standard visualizations) |
||
|
||
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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. why are we talking about amazon ecs |
||
|
||
Alerts will be supported in a future release. | ||
{: .note } | ||
|
||
## Use cases | ||
|
||
Use cases for SSO include: | ||
|
||
* Ingesting observability data from different data types. | ||
* Moving from proprietary configurations that are non-transferable to a consolidated, sharable observability solution that allows users to ingest and display an analysis of any type of telemetry data from any type of provider. | ||
|
||
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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. in a different way than SSO traces. -> in addition and thus enriching the standard trace signal with additional calculated field. |
||
{: .note } | ||
|
||
## Traces and metrics | ||
|
||
Schema definitions for traces and metrics are defined and supported by the Observability plugin. | ||
|
||
These schema definitions include: | ||
|
||
- The index structure (mapping). | ||
- The [index naming conventions](https://github.com/opensearch-project/observability/issues/1405). | ||
- A JSON schema for enforcement and validation of the structure. | ||
- The [integration](https://github.com/opensearch-project/OpenSearch-Dashboards/issues/3412) feature for adding preconfigured dashboards and assets. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
data-driven events -> data-driven-signals