Skip to content

Commit

Permalink
append service & traces analytics docs & info
Browse files Browse the repository at this point in the history
Signed-off-by: YANGDB <[email protected]>
  • Loading branch information
YANG-DB committed May 18, 2023
1 parent a1180ee commit 7cdad55
Show file tree
Hide file tree
Showing 13 changed files with 11,517 additions and 275 deletions.
2 changes: 1 addition & 1 deletion docs/schema/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ For example the [`logs.schema`](../../src/main/resources/schema/observability/lo
...
```

We can observe that the `traceId` field is defined by referencing to the [Span](../../src/main/resources/schema/observability/traces/traceGroups.schema) schema and explicitly to the `#/properties/spanId` field reference location.
We can observe that the `traceId` field is defined by referencing to the [Span](../../src/main/resources/schema/observability/traces/tracegroups.schema) schema and explicitly to the `#/properties/spanId` field reference location.

### Mapping related
Each mapping template will contain the foreign schemas that are referenced to in that specific mapping file. For example the [`logs.mapping`](../../src/main/resources/schema/observability/logs/logs.schema) file will contain the next correlation object in the mapping `_meta` section:
Expand Down
6 changes: 3 additions & 3 deletions docs/schema/observability/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ For example the [`logs.schema`](../../../src/main/resources/schema/observability
...
```

We can observe that the `traceId` field is defined by referencing to the [Span](../../../src/main/resources/schema/observability/traces/traceGroups.schema) schema and explicitly to the `#/properties/spanId` field reference location.
We can observe that the `traceId` field is defined by referencing to the [Span](../../../src/main/resources/schema/observability/traces/tracegroups.schema) schema and explicitly to the `#/properties/spanId` field reference location.

### Mapping related
Each mapping template will contain the foreign schemas that are referenced to in that specific mapping file. For example the [`logs.mapping`](../../../src/main/resources/schema/observability/logs/logs.schema) file will contain the next correlation object in the mapping `_meta` section:
Expand Down Expand Up @@ -172,7 +172,7 @@ The correlation metadata info is exported in the following way:

### Schema related
In JSON Schema, there is no built-in way to represent relationships directly between multiple schemas, like you would find in a relational database. However, you can establish relationships indirectly by using a combination of `$id`, `$ref`, and consistent property naming across your schemas.
For example the [`logs.schema`](../../../src/main/resources/schema/observability/logs/logs.schema) file contains the next `$ref` references for the `traceId` & `spanId` fields that belong to the [`traces.schema`](../../../src/main/resources/schema/observability/traces/traceGroups.schema).
For example the [`logs.schema`](../../../src/main/resources/schema/observability/logs/logs.schema) file contains the next `$ref` references for the `traceId` & `spanId` fields that belong to the [`traces.schema`](../../../src/main/resources/schema/observability/traces/tracegroups.schema).

```json5
...
Expand All @@ -185,7 +185,7 @@ For example the [`logs.schema`](../../../src/main/resources/schema/observability
...
```

We can observe that the `traceId` field is defined by referencing to the [Span](../../../src/main/resources/schema/observability/traces/traceGroups.schema) schema and explicitly to the `#/properties/spanId` field reference location.
We can observe that the `traceId` field is defined by referencing to the [Span](../../../src/main/resources/schema/observability/traces/tracegroups.schema) schema and explicitly to the `#/properties/spanId` field reference location.

### Mapping related
Each mapping template will contain the foreign schemas that are referenced to in that specific mapping file. For example the [`logs.mapping`](../../../src/main/resources/schema/observability/logs/logs.mapping) file will contain the next correlation object in the mapping `_meta` section:
Expand Down
2 changes: 1 addition & 1 deletion docs/schema/observability/traces/Usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Start the OpenSearch cluster and follow the next steps for manually setup of the

`>> PUT _component_template/tracegroups_template`

Copy the [traceGroups.mapping](../../../../src/main/resources/schema/observability/traces/traceGroups.mapping)
Copy the [traceGroups.mapping](../../../../src/main/resources/schema/observability/traces/tracegroups.mapping)

`>> PUT _index_template/traces`

Expand Down
Loading

0 comments on commit 7cdad55

Please sign in to comment.