Skip to content

Commit 7cdad55

Browse files
committed
append service & traces analytics docs & info
Signed-off-by: YANGDB <[email protected]>
1 parent a1180ee commit 7cdad55

File tree

13 files changed

+11517
-275
lines changed

13 files changed

+11517
-275
lines changed

docs/schema/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ For example the [`logs.schema`](../../src/main/resources/schema/observability/lo
105105
...
106106
```
107107

108-
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.
108+
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.
109109

110110
### Mapping related
111111
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:

docs/schema/observability/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ For example the [`logs.schema`](../../../src/main/resources/schema/observability
4747
...
4848
```
4949

50-
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.
50+
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.
5151

5252
### Mapping related
5353
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:
@@ -172,7 +172,7 @@ The correlation metadata info is exported in the following way:
172172

173173
### Schema related
174174
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.
175-
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).
175+
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).
176176

177177
```json5
178178
...
@@ -185,7 +185,7 @@ For example the [`logs.schema`](../../../src/main/resources/schema/observability
185185
...
186186
```
187187

188-
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.
188+
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.
189189

190190
### Mapping related
191191
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:

docs/schema/observability/traces/Usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Start the OpenSearch cluster and follow the next steps for manually setup of the
77

88
`>> PUT _component_template/tracegroups_template`
99

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

1212
`>> PUT _index_template/traces`
1313

0 commit comments

Comments
 (0)