Releases: signalfx/gdi-specification
Releases · signalfx/gdi-specification
1.7.0
Configuration
Enhancements
SPLUNK_PROFILER_CALL_STACK_INTERVAL
defaults to1000
for single-threaded runtimes.
#325
Repository
Enhancements
- Clarify the default sampling algorithm.
#284 - Require a CLA Assistant GitHub workflow.
#269 - Update the CLA notice in
CONTRIBUTING.md
template.
#269
#274 - Add Renovate as an acceptable alternative to Dependabot.
#271 - Add disk buffering configuration options for RUM mobile instrumentation libraries.
#275 - Update telemetry resource attributes
#277:- Deprecate
splunk.distro.version
, - Change
telemetry.auto.version
totelemetry.distro.version
, - Add
telemetry.distro.name
resource attribute.
- Deprecate
- Relax name restrictions to include Cisco/AppDynamics.
#308
Semantic Conventions
Enhancements
- Deprecate
text
format forprofiling.data.format
.
#285
What's Changed
- Update GA request template after release by @pellared in #259
- GA requests references 1.6.0 by @Kielek in #258
- Update RELEASING.md by @breedx-splk in #260
- Bump DavidAnson/markdownlint-cli2-action from 12.0.0 to 13.0.0 by @dependabot in #261
- Bump actions/checkout from 4.0.0 to 4.1.0 by @dependabot in #262
- Fix link after moving sem-conv to own repository by @Kielek in #266
- Add CLA Assistant GitHub workflow by @pellared in #268
- Require CLA Assistant GitHub workflow by @pellared in #269
- Update cla.yml permissions by @pellared in #270
- Add renovatebot as a dependency management option by @breedx-splk in #271
- Fix CLA Assistant for dependabot by @pellared in #272
- Bump actions/checkout from 4.1.0 to 4.1.1 by @dependabot in #273
- Update CLA notice in CONTRIBUTING.md by @pellared in #274
- Add disk buffering config options to RUM conf by @mhennoch in #275
- Update telemetry resource attributes by @Kielek in #277
- Bump DavidAnson/markdownlint-cli2-action from 13.0.0 to 14.0.0 by @dependabot in #282
- Deprecate
text
format forprofiling.data.format
by @Kielek in #285 - Bump lycheeverse/lychee-action from 1.8.0 to 1.9.0 by @dependabot in #286
- Bump lycheeverse/lychee-action from 1.9.0 to 1.9.1 by @dependabot in #287
- Create lychee GH issues only when action is failing by @Kielek in #289
- Bump DavidAnson/markdownlint-cli2-action from 14.0.0 to 15.0.0 by @dependabot in #290
- Bump peter-evans/create-issue-from-file from 4.0.1 to 5.0.0 by @dependabot in #291
- Bump lycheeverse/lychee-action from 1.9.1 to 1.9.2 by @dependabot in #292
- Bump lycheeverse/lychee-action from 1.9.2 to 1.9.3 by @dependabot in #293
- Bump actions/checkout from 4.1.1 to 4.1.2 by @dependabot in #294
- Bump cla-assistant/github-action from 2.3.1 to 2.3.2 by @dependabot in #295
- Bump DavidAnson/markdownlint-cli2-action from 15.0.0 to 16.0.0 by @dependabot in #296
- Fix CLA GitHub Action after GH org rename by @pellared in #297
- Bump actions/checkout from 4.1.2 to 4.1.3 by @dependabot in #298
- Bump actions/checkout from 4.1.3 to 4.1.4 by @dependabot in #299
- Bump lycheeverse/lychee-action from 1.9.3 to 1.10.0 by @dependabot in #300
- Bump actions/checkout from 4.1.4 to 4.1.5 by @dependabot in #302
- Bump contributor-assistant/github-action from 2.3.2 to 2.4.0 by @dependabot in #301
- Bump actions/checkout from 4.1.5 to 4.1.6 by @dependabot in #303
- Bump actions/checkout from 4.1.6 to 4.1.7 by @dependabot in #304
- Bump contributor-assistant/github-action from 2.4.0 to 2.5.0 by @dependabot in #305
- Bump contributor-assistant/github-action from 2.5.0 to 2.5.1 by @dependabot in #306
- Bump DavidAnson/markdownlint-cli2-action from 16.0.0 to 17.0.0 by @dependabot in #307
- Relax repo name restrictions and include Cisco/AppD by @breedx-splk in #308
- Bump contributor-assistant/github-action from 2.5.1 to 2.5.2 by @dependabot in #309
- Bump contributor-assistant/github-action from 2.5.2 to 2.6.0 by @dependabot in #310
- Bump peter-evans/create-issue-from-file from 5.0.0 to 5.0.1 by @dependabot in #311
- Bump actions/checkout from 4.1.7 to 4.2.0 by @dependabot in #312
- Bump contributor-assistant/github-action from 2.6.0 to 2.6.1 by @dependabot in #313
- Bump actions/checkout from 4.2.0 to 4.2.1 by @dependabot in #314
- Bump lycheeverse/lychee-action from 1.10.0 to 2.0.0 by @dependabot in #315
- Bump lycheeverse/lychee-action from 2.0.0 to 2.0.2 by @dependabot in #317
- Fix default value explanation for SPLUNK_PROFILER_LOGS_ENDPOINT by @seemk in #318
- Bump actions/checkout from 4.2.1 to 4.2.2 by @dependabot in #319
- Bump lycheeverse/lychee-action from 2.0.2 to 2.1.0 by @dependabot in #320
- Bump DavidAnson/markdownlint-cli2-action from 17.0.0 to 18.0.0 by @dependabot in #321
- Remove semantic convention from Call Stack Span Association by @pellared in #324
- Update SPLUNK_PROFILER_CALL_STACK_INTERVAL default by @pellared in #325
- Clarify default sampler by @seemk in #284
- Refactor versioning docs by @pellared in #328
- Bump lycheeverse/lychee-action from 2.1.0 to 2.2.0 by @dependabot in #330
- Bump DavidAnson/markdownlint-cli2-action from 18.0.0 to 19.0.0 by @dependabot in #331
- Release 1.7.0 by @pellared in #329
New Contributors
Full Changelog: v1.6.0...v1.7.0
1.6.0
Configuration
Enhancements
- Update the log message when
service.name
resource attribute is not set.
Repository
Enhancements
- Update
CONTRIBUTING.md
template to require signing commits. - Suggest changelog sub-sections and labels.
- Require releases to contain a link to the upstream release notes.
- Add repiository permission exception for bot accounts.
- Remove
signalfx/gdi-specification-*
teams from permissions. - Add admins team.
Release v1.5.0
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 forOTEL_TRACES_EXPORTER
. - Remove the policy regarding Zipkin exporter.
- OTLP exporter can use either
grpc
orhttp/protobuf
as the default transport protocol.
Repository
Enhancements
- Add tag protection rule requirement.
- Add Dependabot security configuration requirements.
- Grant Admin role for maintainers team.
- Allow using the documentation public repository
and reference it in theCONTRIBUTING.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
Breaking Changes
- Remove
telemetry.sdk.language
attribute fromResourceLogs.resource
.
Bugfixes
- Remove redunant and conflicting statement about file and line for
ResourceLogs
.
Enhancements
- Recommened adding
container.id
,host.id
,process.pid
attributes
toResourceLogs.resource
. - Recommend setting process resource attributes.
- Recommend collecting runtime environment metrics.
- Add a required
profiling.data.total.frame.count
attribute toLogRecord
forpprof-gzip-base64
. - Relax the meaning of
allocation
inLogRecord
forpprof-gzip-base64
.
Release v1.4.0
Configuration
- The RUM configuration is now stable.
Semantic Conventions
Breaking Changes
- Remove
namespace
field from profiling stack-trace lines and incorporate it to the function
field. - Remove line and column ranges in profiling stack-trace lines.
Bugfixes
- Clarify that there are two metadata lines (thread metadata and thread state),
both of which can be left empty, containing only the newline.
Enhancements
- Add a required
telemetry.sdk.language
attribute toResourceLogs.resource
. - Allow
:
characters in file names. - Clarify
source.event.period
unit is milliseconds.
Release v1.3.0
General
- Add support information into versioning specification.
- Add behaviors specification.
- Refactor profiling into existing specification structure.
Bug fixes
- Replaced the example for Java system properties in
specification/configuration.md
. - Increase profiling rate from 1s to 10s.
Configuration
Breaking Changes
- Change the Kubernetes package management solutions configuration option default for
splunkPlatform.metricsEnabled
to befalse
.
Enhancements
- Add
SPLUNK_REALM
to required environment variables that need to be supported by instrumentation libraries. - Add
SPLUNK_PROFILER*
environment variables (SPLUNK_PROFILER_CALL_STACK_INTERVAL
,SPLUNK_PROFILER_ENABLED
,SPLUNK_PROFILER_LOGS_ENDPOINT
) to the required configuration for instrumentation libraries. - Add
OTEL_TRACES_EXPORTER
to required environment variables that need to be supported by serverless instrumentation libraries.
Semantic Conventions
Breaking Changes
- Use
os.name
instead ofos.type
for mobile RUM libraries.
Bugfixes
- Correct stability guarantee of the RUM section as experimental.
Enhancements
- Add experimental profiling semantic conventions.
Release v1.2.0
General
Bug fixes
- Properly use the terms "component" and "GDI repository".
Configuration
Enhancements
- Add experimental specification for the configuration for Kubernetes package
management solutions.
Bug fixes
- Properly specify configuration statuses for RUM and serverless. These
sections of the configuration specification are not stable and are correctly
identified as such now. - Clarify requirement for RUM
beaconEndpoint
configuration value to be HTTPS
only on systems that allow such enforcement.
Versioning
Enhancements
- Add information about packaging project versioning. This allows packaging
projects to be released as stable without the need for the project they
package to be stable.
Full Changelog: v1.1.0...v1.2.0
Release 1.1.0
Repository
- Update template CODEOWNERS file to include the Splunk documentation team.
- Add repository LICENSE template.
- Clarify maintainer and approver teams can be shared across repositories.
Configuration
- Add support for the
OTEL_SERVICE_NAME
environment variable. - Remove suggestion for end users of instrumentation libraries to provide
configuration. - Add RUM libraries configuration specification.
- Set the default value for
OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT
to12000
,
instead of the default OpenTelemetry of unlimited. - Require repositories to link to official Splunk docs in
README.md
. - Add Serverless libraries configuration specification.
Profiling
- Initial, experimental, specification for profiling libraries added.
Release 1.0.0
General
- First stable release of the GDI specification. This release includes stable requirements and recommendations for GDI repository composition and versioning and Splunk distributions of OpenTelemetry configuration.
Release v1.0.0-rc.3
General
- Update stability guarantee for all specification documents.
Release v1.0.0-rc.2
General
- How experimental components are added and maintained in a project is now specified.
- Recommendations and requirements for distribution semantic conventions have been added.
Repository
Enhancements
- Guidance for repository permissions have been clarified. No individual is allowed to be granted permissions and all approvers now are assigned write permission to the repository.
- Relaxed requirement to include a
RELEASING.md
file. Projects with private build processes should not publish this information.
Versioning
Enhancements
- Clarified that the versioning policy applies to components of repositories.