From e5f50f03c1d5791d802de850df468000033e45b1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Thu, 30 Mar 2023 14:57:13 +0200 Subject: [PATCH 1/5] Release 1.5.0 --- .github/ISSUE_TEMPLATE/ga_request.md | 26 +++++++-------- CHANGELOG.md | 48 +++++++++++++++++++++++++++- 2 files changed, 60 insertions(+), 14 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/ga_request.md b/.github/ISSUE_TEMPLATE/ga_request.md index 22ee2db..2a069d4 100644 --- a/.github/ISSUE_TEMPLATE/ga_request.md +++ b/.github/ISSUE_TEMPLATE/ga_request.md @@ -11,16 +11,16 @@ assignees: '' Name and link to repository -### Does the repository follow the latest tagged minor release in [GDI specification](https://github.com/signalfx/gdi-specification/blob/v1.4.0/specification/repository.md)? +### Does the repository follow the latest tagged minor release in [GDI specification](https://github.com/signalfx/gdi-specification/blob/v1.5.0/specification/repository.md)? -- [ ] Has an appropriate [maintainers team](https://github.com/signalfx/gdi-specification/blob/v1.4.0/specification/repository.md#teams). -- [ ] [Permissions](https://github.com/signalfx/gdi-specification/blob/v1.4.0/specification/repository.md#permissions) set correctly. -- [ ] [Branch protection](https://github.com/signalfx/gdi-specification/blob/v1.4.0/specification/repository.md#branch-protection) in place. -- [ ] [Dependencies](https://github.com/signalfx/gdi-specification/blob/v1.4.0/specification/repository.md#dependencies) appropriately locked down. -- [ ] [GitHub Applications](https://github.com/signalfx/gdi-specification/blob/v1.4.0/specification/repository.md#github-applications) set up per spec. -- [ ] Follows the [configuration requirements](https://github.com/signalfx/gdi-specification/blob/v1.4.0/specification/configuration.md), if appropriate. -- [ ] Follows the [semantic convention requirements](https://github.com/signalfx/gdi-specification/blob/v1.4.0/specification/semantic_conventions.md), if appropriate. -- [ ] [Required Files](https://github.com/signalfx/gdi-specification/blob/v1.4.0/specification/repository.md#required-files) in place. +- [ ] Has an appropriate [maintainers team](https://github.com/signalfx/gdi-specification/blob/v1.5.0/specification/repository.md#teams). +- [ ] [Permissions](https://github.com/signalfx/gdi-specification/blob/v1.5.0/specification/repository.md#permissions) set correctly. +- [ ] [Branch protection](https://github.com/signalfx/gdi-specification/blob/v1.5.0/specification/repository.md#branch-protection) in place. +- [ ] [Dependencies](https://github.com/signalfx/gdi-specification/blob/v1.5.0/specification/repository.md#dependencies) appropriately locked down. +- [ ] [GitHub Applications](https://github.com/signalfx/gdi-specification/blob/v1.5.0/specification/repository.md#github-applications) set up per spec. +- [ ] Follows the [configuration requirements](https://github.com/signalfx/gdi-specification/blob/v1.5.0/specification/configuration.md), if appropriate. +- [ ] Follows the [semantic convention requirements](https://github.com/signalfx/gdi-specification/blob/v1.5.0/specification/semantic_conventions.md), if appropriate. +- [ ] [Required Files](https://github.com/signalfx/gdi-specification/blob/v1.5.0/specification/repository.md#required-files) in place. - [ ] CHANGELOG.md - [ ] CODE_OF_CONDUCT.md - [ ] CONTRIBUTING.md @@ -33,17 +33,17 @@ Name and link to repository - [ ] Link to official Splunk docs - [ ] License information - [ ] SECURITY.md -- [ ] [Releases](https://github.com/signalfx/gdi-specification/blob/v1.4.0/specification/repository.md#github-releases) done to spec. +- [ ] [Releases](https://github.com/signalfx/gdi-specification/blob/v1.5.0/specification/repository.md#github-releases) done to spec. - [ ] Type specific requirements (remove what doesn't apply) - - [ ] [Data Collector](https://github.com/signalfx/gdi-specification/blob/v1.4.0/specification/repository.md#data-collector) + - [ ] [Data Collector](https://github.com/signalfx/gdi-specification/blob/v1.5.0/specification/repository.md#data-collector) - [ ] Documents all supported configuration parameters. - [ ] Documents sizing guidelines - - [ ] [Instrumentation Library](https://github.com/signalfx/gdi-specification/blob/v1.4.0/specification/repository.md#instrumentation-libraries) + - [ ] [Instrumentation Library](https://github.com/signalfx/gdi-specification/blob/v1.5.0/specification/repository.md#instrumentation-libraries) - [ ] Documents all supported configuration parameters. - [ ] Documents how to configure manual instrumentation. - [ ] Documents how to configure log correlation. - [ ] Documents minimum supported version of each auto-instrumentation framework. - - [ ] [Real User Monitoring Library](https://github.com/signalfx/gdi-specification/blob/v1.4.0/specification/repository.md#real-user-monitoring-libraries) + - [ ] [Real User Monitoring Library](https://github.com/signalfx/gdi-specification/blob/v1.5.0/specification/repository.md#real-user-monitoring-libraries) - [ ] Documents all supported configuration parameters. - [ ] Documents how to configure manual instrumentation. - [ ] Documents supported instrumentation. diff --git a/CHANGELOG.md b/CHANGELOG.md index 1c4f45d..9287b20 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,51 @@ ## [Unreleased] +## [1.5.0] - 2023-03-30 + +### Configuration + +#### Bugfixes + +- Remove `SPLUNK_METRICS_ENDPOINT` from Instrumentation Libraries + (it was never really stable). + +#### Enhancements + +- Add `SPLUNK_PROFILER_MEMORY_ENABLED`. +- Deprecate `jaeger-thrift-splunk` option for `OTEL_TRACES_EXPORTER`. +- Remove the policy regarding Zipkin exporter. +- OTLP exporter can use either `grpc` or `http/protobuf` + as the default transport protocol. + +### Repository + +#### Enhancements + +- Add tag protection rule requirement. +- Add Dependabot security configuration requirements. +- Grant Admin role for maintainers team. +- Refine documentation requirements. + +### Semantic Conventions + +#### Breaking Changes + +- Remove `telemetry.sdk.language` attribute from `ResourceLogs.resource`. + +### Bugfixes + +- Remove redunant and conflicting statement about file and line for `ResourceLogs`. + +#### Enhancements + +- Recommened adding `container.id`, `host.id`, `process.pid` attributes + to `ResourceLogs.resource`. +- Recommend setting process resource attributes. +- Recommend collecting runtime environment metrics. +- Add a required `profiling.data.total.frame.count` attribute to `LogRecord` for `pprof-gzip-base64`. +- Relax the meaning of `allocation` in `LogRecord` for `pprof-gzip-base64`. + ## [1.4.0] - 2022-08-16 ### Configuration @@ -182,7 +227,8 @@ - Primary focus is on Instrumentation Libraries for initial 1.0 release - Initial Collector specification defined -[Unreleased]: https://github.com/signalfx/gdi-specification/compare/v1.4.0...HEAD +[Unreleased]: https://github.com/signalfx/gdi-specification/compare/v1.5.0...HEAD +[1.5.0]: https://github.com/signalfx/gdi-specification/releases/tag/v1.5.0 [1.4.0]: https://github.com/signalfx/gdi-specification/releases/tag/v1.4.0 [1.3.0]: https://github.com/signalfx/gdi-specification/releases/tag/v1.3.0 [1.2.0]: https://github.com/signalfx/gdi-specification/releases/tag/v1.2.0 From 35ce567dabc36ea05e4dd36a72692f184284c1a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20Kie=C5=82kowicz?= Date: Thu, 30 Mar 2023 16:10:28 +0200 Subject: [PATCH 2/5] md lint fix --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 327d899..b0bfec1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -44,7 +44,8 @@ to `ResourceLogs.resource`. - Recommend setting process resource attributes. - Recommend collecting runtime environment metrics. -- Add a required `profiling.data.total.frame.count` attribute to `LogRecord` for `pprof-gzip-base64`. +- Add a required `profiling.data.total.frame.count` attribute + to `LogRecord` for `pprof-gzip-base64`. - Relax the meaning of `allocation` in `LogRecord` for `pprof-gzip-base64`. ## [1.4.0] - 2022-08-16 From 387812410a06f98c9561a1b1a554808b4acf8d14 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Thu, 30 Mar 2023 21:27:59 +0200 Subject: [PATCH 3/5] Update CHANGELOG.md --- CHANGELOG.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b0bfec1..292cc0d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -26,7 +26,12 @@ - Add tag protection rule requirement. - Add Dependabot security configuration requirements. - Grant Admin role for maintainers team. -- Refine documentation requirements. +- Allow using the documentation public repository + and reference it in the `CONTRIBUTING.md` template. +- Require documenting all configuration parameters + that are relevant to Splunk Observability Cloud. +- Require documenting all configuration parameters + whose default or accepted values deviate from upstream. ### Semantic Conventions From 9dbffff90dae7ad8e325a20cdbde58fc56ed21d8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Thu, 30 Mar 2023 21:32:52 +0200 Subject: [PATCH 4/5] Update ci.yml --- .github/workflows/ci.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index c64fa69..4f86c68 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -19,3 +19,4 @@ jobs: with: args: -v -n "*.md" "**/*.md" fail: true + if: ${{ !contains(github.event.pull_request.labels.*.name, 'release PR') }} From 5c02b3b80953dda180af05edf003eafe8fb1435b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Thu, 30 Mar 2023 21:36:45 +0200 Subject: [PATCH 5/5] Update RELEASING.md --- RELEASING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/RELEASING.md b/RELEASING.md index 6f583b3..2b01dde 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -4,7 +4,8 @@ 1. Update [CHANGELOG.md](CHANGELOG.md) with new the new release. -2. Push the changes to upstream and create a Pull Request on GitHub. +2. Create a pull request with `release PR` label on GitHub + with the changes described in the changelog. ## Tag