Skip to content
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

retract 1.10.0, prepare 1.10.1 #261

Merged
merged 2 commits into from
Aug 29, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,17 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm

## Unreleased

## [1.10.1](https://github.com/lightstep/otel-launcher-go/releases/tag/v1.10.1) - 2022-08-29

- Revert the default change of temporality to "cumulative" from #258.
New users are recommended to configure
`WithMetricExporterTemporalityPreference("stateless")` temporality
preference if possible.

## [1.10.0](https://github.com/lightstep/otel-launcher-go/releases/tag/v1.10.0) - 2022-08-28

This version was retracted because of the change of temporality preference.

### 🧰 Bug fixes 🧰

- Partial error handling: avoid printing spurious messages when there is no error. [#247](https://github.com/lightstep/otel-launcher-go/pull/247)
Expand Down
26 changes: 12 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Additional options
| WithSpanExporterInsecure | OTEL_EXPORTER_OTLP_SPAN_INSECURE | n | false |
| WithMetricExporterEndpoint | OTEL_EXPORTER_OTLP_METRIC_ENDPOINT | n | ingest.lightstep.com:443 |
| WithMetricExporterInsecure | OTEL_EXPORTER_OTLP_METRIC_INSECURE | n | false |
| WithMetricExporterTemporalityPreference | OTEL_EXPORTER_OTLP_METRIC_TEMPORALITY_PREFERENCE | n | stateless |
| WithMetricExporterTemporalityPreference | OTEL_EXPORTER_OTLP_METRIC_TEMPORALITY_PREFERENCE | n | cumulative |
| WithAccessToken | LS_ACCESS_TOKEN | n | - |
| WithLogLevel | OTEL_LOG_LEVEL | n | info |
| WithPropagators | OTEL_PROPAGATORS | n | b3 |
Expand Down Expand Up @@ -124,19 +124,17 @@ to be maintained. The temporality preference is configured by calling
`OTEL_EXPORTER_OTLP_METRIC_TEMPORALITY_PREFERENCE` environment
variable.

The launcher supports an experimental "stateless" temporality
preference. This selection configures the ideal behavior for
Lightstep by mixing temporality setings. This setting uses delta
temporality for synchronous Counter and Histogram instruments, while
using cumulative temporality for asynchronous Counters. Note that
synchronous and asynchronous UpDownCounter instruments are specified
to use cumulative temporality in OpenTelemetry metrics SDKs
independent of the temporality preference.

The exporter temporality preference is set to "stateless" by default,
which is not specified presently in OpenTelemetry. The OpenTelemetry
specified "delta" temporality preference is not recommended for
Lightstep users.
The launcher supports a "stateless" temporality preference. This
selection configures the ideal behavior for Lightstep by mixing
temporality setings.

The 1.x launcher release series configures the "cumulative"
temporality preference by default. The next major release of launcher
will configure the "stateless" temporality preference.

Lightstep users are recommended to select either the "cumulative" or
"stateless" preference. The OpenTelemetry-specified "delta"
temporality preference is not recommended for Lightstep users.

### Metrics validation errors

Expand Down
5 changes: 5 additions & 0 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,8 @@ require (
replace github.com/lightstep/otel-launcher-go/pipelines => ./pipelines

replace github.com/lightstep/otel-launcher-go/lightstep/sdk/metric => ./lightstep/sdk/metric

// The 1.10.0 release included an unneccessary breaking change of
// default temporality preference; use 1.10.1 instead or consider
// upgrading to a 2.x release.
retract v1.10.0
2 changes: 1 addition & 1 deletion launcher/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ type Config struct {
Headers map[string]string `env:"OTEL_EXPORTER_OTLP_HEADERS"`
MetricExporterEndpoint string `env:"OTEL_EXPORTER_OTLP_METRIC_ENDPOINT,default=ingest.lightstep.com:443"`
MetricExporterEndpointInsecure bool `env:"OTEL_EXPORTER_OTLP_METRIC_INSECURE,default=false"`
MetricExporterTemporalityPreference string `env:"OTEL_EXPORTER_OTLP_METRIC_TEMPORALITY_PREFERENCE,default=stateless"`
MetricExporterTemporalityPreference string `env:"OTEL_EXPORTER_OTLP_METRIC_TEMPORALITY_PREFERENCE,default=cumulative"`
MetricsEnabled bool `env:"LS_METRICS_ENABLED,default=true"`
LogLevel string `env:"OTEL_LOG_LEVEL,default=info"`
Propagators []string `env:"OTEL_PROPAGATORS,default=b3"`
Expand Down
2 changes: 1 addition & 1 deletion launcher/config_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -375,7 +375,7 @@ func (suite *testSuite) TestDefaultConfig() {
MetricExporterEndpointInsecure: false,
MetricReportingPeriod: "30s",
MetricsEnabled: true,
MetricExporterTemporalityPreference: "stateless",
MetricExporterTemporalityPreference: "cumulative",
LogLevel: "info",
Propagators: []string{"b3"},
Resource: resource.NewWithAttributes(semconv.SchemaURL, attributes...),
Expand Down