Skip to content

Commit

Permalink
Add customer dashboard packages (#16)
Browse files Browse the repository at this point in the history
* Add customer dashboard packages

Add customer dashboard packages:
- go
- nodejs
- opentelemetry demo

* Update description of the packages readme

Update description of the packages readme

* Update metrics name in demo

* Update description of metrics
  • Loading branch information
liyanwei93 authored Nov 20, 2024
1 parent 7fc0eaa commit 6a00afb
Show file tree
Hide file tree
Showing 10 changed files with 4,214 additions and 0 deletions.
46 changes: 46 additions & 0 deletions packages/@instana-integration/go/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# @instana-integration/go

The Instana integration package used to support Go monitoring. Once you import this package into your Instana environment, you will be able to monitor Go runtime and the applications on various aspects by checking the dashboards, alerts, etc. included in this integration package.

## Dashboards

Below are the dashboards that are currently supported by this integration package.

| Dashboard Title | Description |
|----------------------------|-----------------------|
| Go Runtime Metrics | Instana custom dashboard that displays runtime metrics for Go application |

### Go Runtime Metrics

### Semantic Conventions for Go Runtime Metrics

The Go runtime metrics are obtained by OpenTelemetry auto-instrumentation:

```
import "go.opentelemetry.io/contrib/instrumentation/runtime"
err := runtime.Start(runtime.WithMinimumReadMemStatsInterval(time.Second))
if err != nil {
log.Fatal(err)
}
```

Below are the Go runtime metrics that are currently supported by this integration package.

| Metrics Name | Description | Unit |
|----------------------------|-------------------------------|--------|
| process.runtime.go.mem.heap_inuse | Heap used | Number |
| process.runtime.go.mem.heap.alloc | Allocated memory | Byte |
| process.runtime.go.mem.heap.sys | System heap | Byte |
| process.runtime.go.mem.heap.inuse | Used heap | Byte |
| process.runtime.go.mem.heap.objects | Objects | Byte |
| process.runtime.go.goroutines | Executed goroutines | Number |


### Resource Attributes for Go Application

Below are the resource attributes that are currently supported by this integration package.

| Attribute Key | Type | Description |
|----------------------------|-------|------------------------|
| service.name | string | This attribute is used to describe the entity name. |
| service.instance.id | string | This attribute is used to describe the entity ID of the current object. |
Loading

0 comments on commit 6a00afb

Please sign in to comment.