Skip to content

Commit

Permalink
Delete deprecated InstrumentationLibrary-related fields and messages (#…
Browse files Browse the repository at this point in the history 
…407)

The fields and messages were scheduled to be deleted on June 15, 2022,
so now is a good time to do it (especially before we declare OTLP 1.0).
  • Loading branch information
@tigrannajaryan
tigrannajaryan authored Jun 27, 2022
1 parent 9e7c1b3 commit 1e69bf2
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 157 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ Full list of differences found in [this compare](https://github.com/open-telemet
* Add `csharp_namespace` option to protos.
([#399](https://github.com/open-telemetry/opentelemetry-proto/pull/399))
* Fix some out-of-date urls which link to [specification](https://github.com/open-telemetry/opentelemetry-specification). ([#402](https://github.com/open-telemetry/opentelemetry-proto/pull/402))
* :stop_sign: [BREAKING] Delete deprecated InstrumentationLibrary,
InstrumentationLibraryLogs, InstrumentationLibrarySpans and
InstrumentationLibraryMetrics messages. Delete deprecated
instrumentation_library_logs, instrumentation_library_spans and
instrumentation_library_metrics fields.

### Added

Expand Down
13 changes: 0 additions & 13 deletions opentelemetry/proto/common/v1/common.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,19 +66,6 @@ message KeyValue {
AnyValue value = 2;
}

// InstrumentationLibrary is a message representing the instrumentation library information
// such as the fully qualified name and version.
// InstrumentationLibrary is wire-compatible with InstrumentationScope for binary
// Protobuf format.
// This message is deprecated and will be removed on June 15, 2022.
message InstrumentationLibrary {
option deprecated = true;

// An empty instrumentation library name means the name is unknown.
string name = 1;
string version = 2;
}

// InstrumentationScope is a message representing the instrumentation scope information
// such as the fully qualified name and version.
message InstrumentationScope {
Expand Down
50 changes: 2 additions & 48 deletions opentelemetry/proto/logs/v1/logs.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,42 +46,15 @@ message LogsData {

// A collection of ScopeLogs from a Resource.
message ResourceLogs {
reserved 1000;

// The resource for the logs in this message.
// If this field is not set then resource info is unknown.
opentelemetry.proto.resource.v1.Resource resource = 1;

// A list of ScopeLogs that originate from a resource.
repeated ScopeLogs scope_logs = 2;

// A list of InstrumentationLibraryLogs that originate from a resource.
// This field is deprecated and will be removed after grace period expires on June 15, 2022.
//
// During the grace period the following rules SHOULD be followed:
//
// For Binary Protobufs
// ====================
// Binary Protobuf senders SHOULD NOT set instrumentation_library_logs. Instead
// scope_logs SHOULD be set.
//
// Binary Protobuf receivers SHOULD check if instrumentation_library_logs is set
// and scope_logs is not set then the value in instrumentation_library_logs
// SHOULD be used instead by converting InstrumentationLibraryLogs into ScopeLogs.
// If scope_logs is set then instrumentation_library_logs SHOULD be ignored.
//
// For JSON
// ========
// JSON senders that set instrumentation_library_logs field MAY also set
// scope_logs to carry the same logs, essentially double-publishing the same data.
// Such double-publishing MAY be controlled by a user-settable option.
// If double-publishing is not used then the senders SHOULD set scope_logs and
// SHOULD NOT set instrumentation_library_logs.
//
// JSON receivers SHOULD check if instrumentation_library_logs is set and
// scope_logs is not set then the value in instrumentation_library_logs
// SHOULD be used instead by converting InstrumentationLibraryLogs into ScopeLogs.
// If scope_logs is set then instrumentation_library_logs field SHOULD be ignored.
repeated InstrumentationLibraryLogs instrumentation_library_logs = 1000 [deprecated = true];

// This schema_url applies to the data in the "resource" field. It does not apply
// to the data in the "scope_logs" field which have their own schema_url field.
string schema_url = 3;
Expand All @@ -101,25 +74,6 @@ message ScopeLogs {
string schema_url = 3;
}

// A collection of Logs produced by an InstrumentationLibrary.
// InstrumentationLibraryLogs is wire-compatible with ScopeLogs for binary
// Protobuf format.
// This message is deprecated and will be removed on June 15, 2022.
message InstrumentationLibraryLogs {
option deprecated = true;

// The instrumentation library information for the logs in this message.
// Semantically when InstrumentationLibrary isn't set, it is equivalent with
// an empty instrumentation library name (unknown).
opentelemetry.proto.common.v1.InstrumentationLibrary instrumentation_library = 1;

// A list of logs that originate from an instrumentation library.
repeated LogRecord log_records = 2;

// This schema_url applies to all logs in the "logs" field.
string schema_url = 3;
}

// Possible values for LogRecord.SeverityNumber.
enum SeverityNumber {
// UNSPECIFIED is the default SeverityNumber, it MUST NOT be used.
Expand Down
50 changes: 2 additions & 48 deletions opentelemetry/proto/metrics/v1/metrics.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,42 +46,15 @@ message MetricsData {

// A collection of ScopeMetrics from a Resource.
message ResourceMetrics {
reserved 1000;

// The resource for the metrics in this message.
// If this field is not set then no resource info is known.
opentelemetry.proto.resource.v1.Resource resource = 1;

// A list of metrics that originate from a resource.
repeated ScopeMetrics scope_metrics = 2;

// A list of InstrumentationLibraryMetrics that originate from a resource.
// This field is deprecated and will be removed after grace period expires on June 15, 2022.
//
// During the grace period the following rules SHOULD be followed:
//
// For Binary Protobufs
// ====================
// Binary Protobuf senders SHOULD NOT set instrumentation_library_metrics. Instead
// scope_metrics SHOULD be set.
//
// Binary Protobuf receivers SHOULD check if instrumentation_library_metrics is set
// and scope_metrics is not set then the value in instrumentation_library_metrics
// SHOULD be used instead by converting InstrumentationLibraryMetrics into ScopeMetrics.
// If scope_metrics is set then instrumentation_library_metrics SHOULD be ignored.
//
// For JSON
// ========
// JSON senders that set instrumentation_library_metrics field MAY also set
// scope_metrics to carry the same metrics, essentially double-publishing the same data.
// Such double-publishing MAY be controlled by a user-settable option.
// If double-publishing is not used then the senders SHOULD set scope_metrics and
// SHOULD NOT set instrumentation_library_metrics.
//
// JSON receivers SHOULD check if instrumentation_library_metrics is set and
// scope_metrics is not set then the value in instrumentation_library_metrics
// SHOULD be used instead by converting InstrumentationLibraryMetrics into ScopeMetrics.
// If scope_metrics is set then instrumentation_library_metrics field SHOULD be ignored.
repeated InstrumentationLibraryMetrics instrumentation_library_metrics = 1000 [deprecated = true];

// This schema_url applies to the data in the "resource" field. It does not apply
// to the data in the "scope_metrics" field which have their own schema_url field.
string schema_url = 3;
Expand All @@ -101,25 +74,6 @@ message ScopeMetrics {
string schema_url = 3;
}

// A collection of Metrics produced by an InstrumentationLibrary.
// InstrumentationLibraryMetrics is wire-compatible with ScopeMetrics for binary
// Protobuf format.
// This message is deprecated and will be removed on June 15, 2022.
message InstrumentationLibraryMetrics {
option deprecated = true;

// The instrumentation library information for the metrics in this message.
// Semantically when InstrumentationLibrary isn't set, it is equivalent with
// an empty instrumentation library name (unknown).
opentelemetry.proto.common.v1.InstrumentationLibrary instrumentation_library = 1;

// A list of metrics that originate from an instrumentation library.
repeated Metric metrics = 2;

// This schema_url applies to all metrics in the "metrics" field.
string schema_url = 3;
}

// Defines a Metric which has one or more timeseries. The following is a
// brief summary of the Metric data model. For more details, see:
//
Expand Down
50 changes: 2 additions & 48 deletions opentelemetry/proto/trace/v1/trace.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,42 +46,15 @@ message TracesData {

// A collection of ScopeSpans from a Resource.
message ResourceSpans {
reserved 1000;

// The resource for the spans in this message.
// If this field is not set then no resource info is known.
opentelemetry.proto.resource.v1.Resource resource = 1;

// A list of ScopeSpans that originate from a resource.
repeated ScopeSpans scope_spans = 2;

// A list of InstrumentationLibrarySpans that originate from a resource.
// This field is deprecated and will be removed after grace period expires on June 15, 2022.
//
// During the grace period the following rules SHOULD be followed:
//
// For Binary Protobufs
// ====================
// Binary Protobuf senders SHOULD NOT set instrumentation_library_spans. Instead
// scope_spans SHOULD be set.
//
// Binary Protobuf receivers SHOULD check if instrumentation_library_spans is set
// and scope_spans is not set then the value in instrumentation_library_spans
// SHOULD be used instead by converting InstrumentationLibrarySpans into ScopeSpans.
// If scope_spans is set then instrumentation_library_spans SHOULD be ignored.
//
// For JSON
// ========
// JSON senders that set instrumentation_library_spans field MAY also set
// scope_spans to carry the same spans, essentially double-publishing the same data.
// Such double-publishing MAY be controlled by a user-settable option.
// If double-publishing is not used then the senders SHOULD set scope_spans and
// SHOULD NOT set instrumentation_library_spans.
//
// JSON receivers SHOULD check if instrumentation_library_spans is set and
// scope_spans is not set then the value in instrumentation_library_spans
// SHOULD be used instead by converting InstrumentationLibrarySpans into ScopeSpans.
// If scope_spans is set then instrumentation_library_spans field SHOULD be ignored.
repeated InstrumentationLibrarySpans instrumentation_library_spans = 1000 [deprecated = true];

// This schema_url applies to the data in the "resource" field. It does not apply
// to the data in the "scope_spans" field which have their own schema_url field.
string schema_url = 3;
Expand All @@ -101,25 +74,6 @@ message ScopeSpans {
string schema_url = 3;
}

// A collection of Spans produced by an InstrumentationLibrary.
// InstrumentationLibrarySpans is wire-compatible with ScopeSpans for binary
// Protobuf format.
// This message is deprecated and will be removed on June 15, 2022.
message InstrumentationLibrarySpans {
option deprecated = true;

// The instrumentation library information for the spans in this message.
// Semantically when InstrumentationLibrary isn't set, it is equivalent with
// an empty instrumentation library name (unknown).
opentelemetry.proto.common.v1.InstrumentationLibrary instrumentation_library = 1;

// A list of Spans that originate from an instrumentation library.
repeated Span spans = 2;

// This schema_url applies to all spans and span events in the "spans" field.
string schema_url = 3;
}

// Span represents a single operation within a trace. Spans can be
// nested to form a trace tree. Spans may also be linked to other spans
// from the same or different trace and form graphs. Often, a trace
Expand Down

0 comments on commit 1e69bf2

Please sign in to comment.