Skip to content

Commit

Permalink
Add experimental go runtime metrics semantic conventions (#981)
Browse files Browse the repository at this point in the history
  • Loading branch information
dashpole committed May 23, 2024
1 parent a47cced commit c54b6c8
Show file tree
Hide file tree
Showing 10 changed files with 591 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .chloggen/go-runtime-metrics.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Use this changelog template to create an entry for release notes.
#
# If your change doesn't affect end users you should instead start
# your pull request title with [chore] or use the "Skip Changelog" label.

# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: new_component

# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
component: go

# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Add new go namespace for Go runtime metrics

# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
# The values here must be integers.
issues: [535]

# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext:
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ body:
- area:file
- area:gcp
- area:gen-ai
- area:go
- area:graphql
- area:heroku
- area:host
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/change_proposal.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ body:
- area:file
- area:gcp
- area:gen-ai
- area:go
- area:graphql
- area:heroku
- area:host
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/new-conventions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ body:
- area:file
- area:gcp
- area:gen-ai
- area:go
- area:graphql
- area:heroku
- area:host
Expand Down
1 change: 1 addition & 0 deletions docs/attributes-registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ Currently, the following namespaces exist:
- [File](file.md)
- [GCP](gcp.md)
- [Gen AI](gen-ai.md)
- [Go](go.md)
- [GraphQL](graphql.md)
- [Heroku](heroku.md)
- [Host](host.md)
Expand Down
24 changes: 24 additions & 0 deletions docs/attributes-registry/go.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!--- Hugo front matter used to generate the website version of this page:
--->

<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->

# Go

## Go Attributes

This document defines Go related attributes.

| Attribute | Type | Description | Examples | Stability |
| ---------------- | ------ | ------------------- | ---------------- | ---------------------------------------------------------------- |
| `go.memory.type` | string | The type of memory. | `other`; `stack` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

`go.memory.type` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.

| Value | Description | Stability |
| ------- | ----------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
| `stack` | Memory allocated from the heap that is reserved for stack space, whether or not it is currently in-use. [1] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `other` | Memory used by the Go runtime, excluding other categories of memory usage described in this enumeration. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

**[1]:** Computed from `/memory/classes/heap/stacks:bytes`.
1 change: 1 addition & 0 deletions docs/runtime/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ Also consider the
semantic conventions when instrumenting runtime environments.

- [JVM](jvm-metrics.md)
- [Go](go-metrics.md)

### Attributes

Expand Down
Loading

0 comments on commit c54b6c8

Please sign in to comment.