Skip to content

Commit da51680

Browse files
Gandemlmolkova
andauthored
Fix schema_url comments to include scope field coverage (#727)
The schema_url field applies to both the instrumentation scope and the telemetry data fields, not just the telemetry data. Updated comments in all four signal proto files (logs, trace, metrics, profiles) to accurately reflect this. Co-authored-by: Liudmila Molkova <[email protected]>
1 parent d53c5c6 commit da51680

File tree

4 files changed

+8
-4
lines changed

4 files changed

+8
-4
lines changed

opentelemetry/proto/logs/v1/logs.proto

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,8 @@ message ScopeLogs {
7878
// is recorded in. Notably, the last part of the URL path is the version number of the
7979
// schema: http[s]://server[:port]/path/<version>. To learn more about Schema URL see
8080
// https://opentelemetry.io/docs/specs/otel/schemas/#schema-url
81-
// This schema_url applies to all logs in the "logs" field.
81+
// This schema_url applies to the data in the "scope" field and all logs in the
82+
// "log_records" field.
8283
string schema_url = 3;
8384
}
8485

opentelemetry/proto/metrics/v1/metrics.proto

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,8 @@ message ScopeMetrics {
9696
// is recorded in. Notably, the last part of the URL path is the version number of the
9797
// schema: http[s]://server[:port]/path/<version>. To learn more about Schema URL see
9898
// https://opentelemetry.io/docs/specs/otel/schemas/#schema-url
99-
// This schema_url applies to all metrics in the "metrics" field.
99+
// This schema_url applies to the data in the "scope" field and all metrics in the
100+
// "metrics" field.
100101
string schema_url = 3;
101102
}
102103

opentelemetry/proto/profiles/v1development/profiles.proto

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,8 @@ message ScopeProfiles {
219219
// is recorded in. Notably, the last part of the URL path is the version number of the
220220
// schema: http[s]://server[:port]/path/<version>. To learn more about Schema URL see
221221
// https://opentelemetry.io/docs/specs/otel/schemas/#schema-url
222-
// This schema_url applies to all profiles in the "profiles" field.
222+
// This schema_url applies to the data in the "scope" field and all profiles in the
223+
// "profiles" field.
223224
string schema_url = 3;
224225
}
225226

opentelemetry/proto/trace/v1/trace.proto

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,8 @@ message ScopeSpans {
7878
// is recorded in. Notably, the last part of the URL path is the version number of the
7979
// schema: http[s]://server[:port]/path/<version>. To learn more about Schema URL see
8080
// https://opentelemetry.io/docs/specs/otel/schemas/#schema-url
81-
// This schema_url applies to all spans and span events in the "spans" field.
81+
// This schema_url applies to the data in the "scope" field and all spans and span
82+
// events in the "spans" field.
8283
string schema_url = 3;
8384
}
8485

0 commit comments

Comments
 (0)