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.

Sign up for GitHub

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

Fix api/standard constant names and documentation #920

Merged
merged 6 commits into from
Jul 9, 2020
Merged

Fix api/standard constant names and documentation #920

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e06b243
Update spec version sem-conv implement in doc.go
MrAlias Jul 8, 2020
e74826f
Update FaaS key const names to match convention
MrAlias Jul 8, 2020
710c4eb
Add PR number to Changelog
MrAlias Jul 8, 2020
423150a
Merge branch 'master' into fix-sem-conv-names
MrAlias Jul 8, 2020
67477f8
Merge branch 'master' into fix-sem-conv-names
MrAlias Jul 8, 2020
4475cf6
Merge branch 'master' into fix-sem-conv-names
MrAlias Jul 9, 2020
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
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
- The B3 propagator now extracts from either HTTP encoding of B3 (Single Header or Multiple Header) based on what is contained in the header.
Preference is given to Single Header encoding with Multiple Header being the fallback if Single Header is not found or is invalid.
This behavior change is made to dynamically support all correctly encoded traces received instead of having to guess the expected encoding prior to receiving. (#882)
- To match constant naming conventions in the `api/standard` package, the `FaaS*` key names are appended with a suffix of `Key`. (#920)
- `"api/standard".FaaSName` -> `FaaSNameKey`
- `"api/standard".FaaSID` -> `FaaSIDKey`
- `"api/standard".FaaSVersion` -> `FaaSVersionKey`
- `"api/standard".FaaSInstance` -> `FaaSInstanceKey`

### Removed

Expand Down
6 changes: 3 additions & 3 deletions api/standard/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
// use in OpenTelemetry. These standardizations are specified in the
// OpenTelemetry specification:
//
// - https://github.com/open-telemetry/opentelemetry-specification/tree/v0.4.0/specification/resource/semantic_conventions
// - https://github.com/open-telemetry/opentelemetry-specification/tree/v0.4.0/specification/trace/semantic_conventions
// - https://github.com/open-telemetry/opentelemetry-specification/tree/v0.4.0/specification/metrics/semantic_conventions
// - https://github.com/open-telemetry/opentelemetry-specification/tree/v0.6.0/specification/resource/semantic_conventions
// - https://github.com/open-telemetry/opentelemetry-specification/tree/v0.6.0/specification/trace/semantic_conventions
// - https://github.com/open-telemetry/opentelemetry-specification/tree/v0.6.0/specification/metrics/semantic_conventions
package standard
8 changes: 4 additions & 4 deletions api/standard/resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,16 +80,16 @@ const (
// Standard Function-as-a-Service resource attribute keys.
const (
// A uniquely identifying name for the FaaS.
FaaSName = kv.Key("faas.name")
FaaSNameKey = kv.Key("faas.name")

// The unique name of the function being executed.
FaaSID = kv.Key("faas.id")
FaaSIDKey = kv.Key("faas.id")

// The version of the function being executed.
FaaSVersion = kv.Key("faas.version")
FaaSVersionKey = kv.Key("faas.version")

// The execution environment identifier.
FaaSInstance = kv.Key("faas.instance")
FaaSInstanceKey = kv.Key("faas.instance")
)

// Standard Kubernetes resource attribute keys.
Expand Down