From dfae9d7c9adade68ef9f9b7b8fc97705a9ac12c0 Mon Sep 17 00:00:00 2001 From: Dmitry Date: Wed, 30 Nov 2022 13:09:09 -0800 Subject: [PATCH] [mdatagen] Improve generated documentation - Split Metrics into two sections: Default Metrics and Optional Metrics - Split Attributes section and move attributes to the metrics where they applicable to make it clear which attributes applied to a particular metric. - Add "Aggregation Temporality" and "Monotonic" fields to the metric table - Add enum values to Resource attributes --- .chloggen/mdatagen-improve-documentation.yaml | 11 + cmd/mdatagen/loader_test.go | 2 +- cmd/mdatagen/main.go | 75 +- cmd/mdatagen/main_test.go | 28 +- cmd/mdatagen/metricdata.go | 25 +- cmd/mdatagen/metricdata_test.go | 11 - cmd/mdatagen/templates/documentation.md.tmpl | 85 +- cmd/mdatagen/templates/metrics.go.tmpl | 2 +- cmd/mdatagen/templates/metrics_test.go.tmpl | 2 +- cmd/mdatagen/testdata/documentation.md | 27 - .../documentation.md | 434 +++- receiver/aerospikereceiver/documentation.md | 413 +++- receiver/apachereceiver/documentation.md | 281 ++- receiver/bigipreceiver/documentation.md | 708 +++++- receiver/chronyreceiver/documentation.md | 95 +- receiver/couchdbreceiver/documentation.md | 211 +- receiver/dockerstatsreceiver/documentation.md | 381 ++- .../elasticsearchreceiver/documentation.md | 1659 ++++++++++++-- receiver/expvarreceiver/documentation.md | 531 ++++- .../flinkmetricsreceiver/documentation.md | 610 ++++- .../scraper/cpuscraper/documentation.md | 49 +- .../scraper/diskscraper/documentation.md | 228 +- .../filesystemscraper/documentation.md | 95 +- .../scraper/loadscraper/documentation.md | 70 +- .../scraper/memoryscraper/documentation.md | 46 +- .../scraper/networkscraper/documentation.md | 176 +- .../scraper/pagingscraper/documentation.md | 111 +- .../scraper/processesscraper/documentation.md | 62 +- .../scraper/processscraper/documentation.md | 145 +- receiver/httpcheckreceiver/documentation.md | 115 +- receiver/iisreceiver/documentation.md | 273 ++- .../kafkametricsreceiver/documentation.md | 351 ++- .../kubeletstatsreceiver/documentation.md | 833 ++++++- receiver/memcachedreceiver/documentation.md | 275 ++- .../mongodbatlasreceiver/documentation.md | 2034 ++++++++++++++++- receiver/mongodbreceiver/documentation.md | 595 ++++- receiver/mysqlreceiver/documentation.md | 826 ++++++- receiver/nginxreceiver/documentation.md | 96 +- receiver/nsxtreceiver/documentation.md | 202 +- receiver/oracledbreceiver/documentation.md | 495 +++- receiver/postgresqlreceiver/documentation.md | 589 ++++- receiver/rabbitmqreceiver/documentation.md | 142 +- receiver/redisreceiver/documentation.md | 578 ++++- receiver/riakreceiver/documentation.md | 175 +- receiver/saphanareceiver/documentation.md | 1361 ++++++++++- receiver/sqlserverreceiver/documentation.md | 382 +++- receiver/vcenterreceiver/documentation.md | 802 ++++++- receiver/zookeeperreceiver/documentation.md | 312 ++- 48 files changed, 15329 insertions(+), 1680 deletions(-) create mode 100755 .chloggen/mdatagen-improve-documentation.yaml delete mode 100644 cmd/mdatagen/testdata/documentation.md diff --git a/.chloggen/mdatagen-improve-documentation.yaml b/.chloggen/mdatagen-improve-documentation.yaml new file mode 100755 index 000000000000..f9abf619446b --- /dev/null +++ b/.chloggen/mdatagen-improve-documentation.yaml @@ -0,0 +1,11 @@ +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: enhancement + +# The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver) +component: cmd/mdatagen + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Improve generated documentation + +# One or more tracking issues related to the change +issues: [16556] diff --git a/cmd/mdatagen/loader_test.go b/cmd/mdatagen/loader_test.go index 493620cad5bc..c2d3f2e57f09 100644 --- a/cmd/mdatagen/loader_test.go +++ b/cmd/mdatagen/loader_test.go @@ -74,7 +74,7 @@ func Test_loadMetadata(t *testing.T) { Unit: "s", Sum: &sum{ MetricValueType: MetricValueType{pmetric.NumberDataPointValueTypeDouble}, - Aggregated: Aggregated{Aggregation: "cumulative"}, + Aggregated: Aggregated{Aggregation: pmetric.AggregationTemporalityCumulative}, Mono: Mono{Monotonic: true}, }, Attributes: []attributeName{"freeFormAttribute", "freeFormAttributeWithValue", "enumAttribute", "booleanValueType"}, diff --git a/cmd/mdatagen/main.go b/cmd/mdatagen/main.go index 0f12d316d829..2810b83df575 100644 --- a/cmd/mdatagen/main.go +++ b/cmd/mdatagen/main.go @@ -58,19 +58,21 @@ func run(ymlPath string) error { if err = os.MkdirAll(codeDir, 0700); err != nil { return fmt.Errorf("unable to create output directory %q: %w", codeDir, err) } - if err = generateCode(tmplDir, codeDir, "metrics.go", md); err != nil { + if err = generateFile(filepath.Join(tmplDir, "metrics.go.tmpl"), + filepath.Join(codeDir, "generated_metrics.go"), md); err != nil { return err } - if err = generateCode(tmplDir, codeDir, "metrics_test.go", md); err != nil { + if err = generateFile(filepath.Join(tmplDir, "metrics_test.go.tmpl"), + filepath.Join(codeDir, "generated_metrics_test.go"), md); err != nil { return err } - return generateDocumentation(tmplDir, ymlDir, md) + return generateFile(filepath.Join(tmplDir, "documentation.md.tmpl"), filepath.Join(ymlDir, "documentation.md"), md) } -func generateCode(tmplDir string, outputDir string, tmplFile string, md metadata) error { +func generateFile(tmplFile string, outputFile string, md metadata) error { tmpl := template.Must( template. - New(tmplFile + ".tmpl"). + New(filepath.Base(tmplFile)). Option("missingkey=error"). Funcs(map[string]interface{}{ "publicVar": func(s string) (string, error) { @@ -85,6 +87,9 @@ func generateCode(tmplDir string, outputDir string, tmplFile string, md metadata } return string(an) }, + "metricInfo": func(mn metricName) metric { + return md.Metrics[mn] + }, "parseImportsRequired": func(metrics map[metricName]metric) bool { for _, m := range metrics { if m.Data().HasMetricInputType() { @@ -93,56 +98,34 @@ func generateCode(tmplDir string, outputDir string, tmplFile string, md metadata } return false }, - }).ParseFiles(filepath.Join(tmplDir, tmplFile+".tmpl"))) + "stringsJoin": strings.Join, + }).ParseFiles(tmplFile)) + buf := bytes.Buffer{} if err := tmpl.Execute(&buf, templateContext{metadata: md, Package: "metadata"}); err != nil { return fmt.Errorf("failed executing template: %w", err) } - formatted, err := format.Source(buf.Bytes()) - - if err != nil { - errstr := strings.Builder{} - _, _ = fmt.Fprintf(&errstr, "failed formatting source: %v", err) - errstr.WriteString("--- BEGIN SOURCE ---") - errstr.Write(buf.Bytes()) - errstr.WriteString("--- END SOURCE ---") - return errors.New(errstr.String()) - } - - outputFilepath := filepath.Join(outputDir, "generated_"+tmplFile) - if err := os.Remove(outputFilepath); err != nil && !errors.Is(err, os.ErrNotExist) { - return fmt.Errorf("unable to remove genererated file %q: %w", outputFilepath, err) - } - if err := os.WriteFile(outputFilepath, formatted, 0600); err != nil { - return fmt.Errorf("failed writing %q: %w", outputFilepath, err) + result := buf.Bytes() + + if strings.HasSuffix(outputFile, ".go") { + var err error + result, err = format.Source(buf.Bytes()) + if err != nil { + errstr := strings.Builder{} + _, _ = fmt.Fprintf(&errstr, "failed formatting source: %v", err) + errstr.WriteString("--- BEGIN SOURCE ---") + errstr.Write(buf.Bytes()) + errstr.WriteString("--- END SOURCE ---") + return errors.New(errstr.String()) + } } - return nil -} - -func generateDocumentation(tmplDir string, outputDir string, md metadata) error { - tmpl := template.Must( - template. - New("documentation.md.tmpl"). - Option("missingkey=error"). - Funcs(map[string]interface{}{ - "publicVar": func(s string) (string, error) { - return formatIdentifier(s, true) - }, - "stringsJoin": strings.Join, - }).ParseFiles(filepath.Join(tmplDir, "documentation.md.tmpl"))) - - buf := bytes.Buffer{} - - tmplCtx := templateContext{metadata: md, Package: "metadata"} - if err := tmpl.Execute(&buf, tmplCtx); err != nil { - return fmt.Errorf("failed executing template: %w", err) + if err := os.Remove(outputFile); err != nil && !errors.Is(err, os.ErrNotExist) { + return fmt.Errorf("unable to remove genererated file %q: %w", outputFile, err) } - - outputFile := filepath.Join(outputDir, "documentation.md") - if err := os.WriteFile(outputFile, buf.Bytes(), 0600); err != nil { + if err := os.WriteFile(outputFile, result, 0600); err != nil { return fmt.Errorf("failed writing %q: %w", outputFile, err) } diff --git a/cmd/mdatagen/main_test.go b/cmd/mdatagen/main_test.go index 38c0f2219c71..d918b317cf47 100644 --- a/cmd/mdatagen/main_test.go +++ b/cmd/mdatagen/main_test.go @@ -55,22 +55,17 @@ func Test_runContents(t *testing.T) { yml string } tests := []struct { - name string - args args - expectedDocumentation string - want string - wantErr bool + name string + args args + wantErr bool }{ { - name: "valid metadata", - args: args{validMetadata}, - expectedDocumentation: "testdata/documentation.md", - want: "", + name: "valid metadata", + args: args{validMetadata}, }, { name: "invalid yaml", args: args{"invalid"}, - want: "", wantErr: true, }, } @@ -89,18 +84,7 @@ func Test_runContents(t *testing.T) { require.NoError(t, err) require.FileExists(t, filepath.Join(tmpdir, "internal/metadata/generated_metrics.go")) - - actualDocumentation := filepath.Join(tmpdir, "documentation.md") - require.FileExists(t, actualDocumentation) - if tt.expectedDocumentation != "" { - expectedFileBytes, err := os.ReadFile(tt.expectedDocumentation) - require.NoError(t, err) - - actualFileBytes, err := os.ReadFile(actualDocumentation) - require.NoError(t, err) - - require.Equal(t, expectedFileBytes, actualFileBytes) - } + require.FileExists(t, filepath.Join(tmpdir, "documentation.md")) }) } } diff --git a/cmd/mdatagen/metricdata.go b/cmd/mdatagen/metricdata.go index 387c5e0a593c..0b4a7886664f 100644 --- a/cmd/mdatagen/metricdata.go +++ b/cmd/mdatagen/metricdata.go @@ -34,22 +34,29 @@ type MetricData interface { } // Aggregated defines a metric aggregation type. +// TODO: Rename to AggregationTemporality type Aggregated struct { // Aggregation describes if the aggregator reports delta changes // since last report time, or cumulative changes since a fixed start time. - Aggregation string `mapstructure:"aggregation" validate:"oneof=delta cumulative"` + Aggregation pmetric.AggregationTemporality `validate:"required"` } -// Type gets the metric aggregation type. -func (agg Aggregated) Type() string { - switch agg.Aggregation { - case "delta": - return "pmetric.AggregationTemporalityDelta" +// UnmarshalText implements the encoding.TextUnmarshaler interface. +func (agg *Aggregated) UnmarshalText(text []byte) error { + switch vtStr := string(text); vtStr { case "cumulative": - return "pmetric.AggregationTemporalityCumulative" + agg.Aggregation = pmetric.AggregationTemporalityCumulative + case "delta": + agg.Aggregation = pmetric.AggregationTemporalityDelta default: - return "pmetric.AggregationTemporalityUnknown" + return fmt.Errorf("invalid aggregation: %q", vtStr) } + return nil +} + +// String returns string representation of the aggregation temporality. +func (agg *Aggregated) String() string { + return agg.Aggregation.String() } // Mono defines the metric monotonicity. @@ -127,7 +134,7 @@ func (d gauge) HasMetricInputType() bool { } type sum struct { - Aggregated `mapstructure:",squash"` + Aggregated `mapstructure:"aggregation"` Mono `mapstructure:",squash"` MetricValueType `mapstructure:"value_type"` MetricInputType `mapstructure:",squash"` diff --git a/cmd/mdatagen/metricdata_test.go b/cmd/mdatagen/metricdata_test.go index 45836d1cd75f..698d5a91cfd4 100644 --- a/cmd/mdatagen/metricdata_test.go +++ b/cmd/mdatagen/metricdata_test.go @@ -35,14 +35,3 @@ func TestMetricData(t *testing.T) { assert.Equal(t, arg.hasMonotonic, arg.metricData.HasMonotonic()) } } - -func TestAggregation(t *testing.T) { - delta := Aggregated{Aggregation: "delta"} - assert.Equal(t, "pmetric.AggregationTemporalityDelta", delta.Type()) - - cumulative := Aggregated{Aggregation: "cumulative"} - assert.Equal(t, "pmetric.AggregationTemporalityCumulative", cumulative.Type()) - - unknown := Aggregated{Aggregation: ""} - assert.Equal(t, "pmetric.AggregationTemporalityUnknown", unknown.Type()) -} diff --git a/cmd/mdatagen/templates/documentation.md.tmpl b/cmd/mdatagen/templates/documentation.md.tmpl index c178c14d9384..ab5fe3daf1fc 100644 --- a/cmd/mdatagen/templates/documentation.md.tmpl +++ b/cmd/mdatagen/templates/documentation.md.tmpl @@ -1,43 +1,88 @@ +{{- define "metric-documenation" -}} +{{- $metricName := . }} +{{- $metric := $metricName | metricInfo -}} + +### {{ $metricName }} + +{{ $metric.Description }} + +{{- if $metric.ExtendedDocumentation }} + +{{ $metric.ExtendedDocumentation }} + +{{- end }} + +| Unit | Metric Type | Value Type |{{ if $metric.Data.HasAggregated }} Aggregation Temporality |{{ end }}{{ if $metric.Data.HasMonotonic }} Monotonic |{{ end }} +| ---- | ----------- | ---------- |{{ if $metric.Data.HasAggregated }} ----------------------- |{{ end }}{{ if $metric.Data.HasMonotonic }} --------- |{{ end }} +| {{ $metric.Unit }} | {{ $metric.Data.Type }} | {{ $metric.Data.MetricValueType }} | +{{- if $metric.Data.HasAggregated }} {{ $metric.Data.Aggregated }} |{{ end }} +{{- if $metric.Data.HasMonotonic }} {{ $metric.Data.Monotonic }} |{{ end }} + +{{- if $metric.Attributes }} + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +{{- range $metric.Attributes }} +{{- $attribute := . | attributeInfo }} +| {{ . | attributeKey }} | {{ $attribute.Description }} | +{{- if $attribute.Enum }} {{ $attribute.Type }}: ``{{ stringsJoin $attribute.Enum "``, ``" }}``{{ else }} Any {{ $attribute.Type }}{{ end }} | +{{- end }} + +{{- end }} + +{{- end -}} + [comment]: <> (Code generated by mdatagen. DO NOT EDIT.) # {{ .Name }} -## Metrics +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: + +```yaml +metrics: + : + enabled: false +``` + +{{- range $metricName, $metric := .Metrics }} +{{- if $metric.IsEnabled }} -These are the metrics available for this scraper. +{{ template "metric-documenation" $metricName }} -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -{{- range $metricName, $metricInfo := .Metrics }} -| {{ if $metricInfo.IsEnabled }}**{{ end }}{{ $metricName }}{{ if $metricInfo.IsEnabled }}** -{{- end }} | {{ $metricInfo.Description }}{{ if $metricInfo.ExtendedDocumentation }} {{ $metricInfo.ExtendedDocumentation }}{{ end }} | {{ $metricInfo.Unit }} | {{ $metricInfo.Data.Type }}({{ $metricInfo.Data.MetricValueType }}) | | {{- end }} +{{- end }} + +## Optional Metrics -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -{{- if .ResourceAttributes }} +{{- range $metricName, $metric := .Metrics }} +{{- if $metric.IsEnabled }} -## Resource attributes +{{ template "metric-documenation" $metricName }} -| Name | Description | Type | -| ---- | ----------- | ---- | -{{- range $attributeName, $attributeInfo := .ResourceAttributes }} -| {{ $attributeName }} | {{ $attributeInfo.Description }} | {{ $attributeInfo.Type }} | {{- end }} {{- end }} -## Metric attributes +{{- if .ResourceAttributes }} + +## Resource Attributes | Name | Description | Values | | ---- | ----------- | ------ | -{{- range $attributeName, $attributeInfo := .Attributes }} -| {{ $attributeName }}{{- if $attributeInfo.Value }} ({{ $attributeInfo.Value }}){{- end}} | {{ $attributeInfo.Description }} | {{ stringsJoin $attributeInfo.Enum ", " }} | +{{- range $attributeName, $attribute := .ResourceAttributes }} +| {{ $attributeName }} | {{ $attribute.Description }} | +{{- if $attribute.Enum }} {{ $attribute.Type }}: ``{{ stringsJoin $attribute.Enum "``, ``" }}``{{ else }} Any {{ $attribute.Type }}{{ end }} | +{{- end }} + {{- end }} diff --git a/cmd/mdatagen/templates/metrics.go.tmpl b/cmd/mdatagen/templates/metrics.go.tmpl index c81a55478e02..c9b7099327d2 100644 --- a/cmd/mdatagen/templates/metrics.go.tmpl +++ b/cmd/mdatagen/templates/metrics.go.tmpl @@ -109,7 +109,7 @@ func (m *metric{{ $name.Render }}) init() { m.data.{{ $metric.Data.Type }}().SetIsMonotonic({{ $metric.Data.Monotonic }}) {{- end }} {{- if $metric.Data.HasAggregated }} - m.data.{{ $metric.Data.Type }}().SetAggregationTemporality({{ $metric.Data.Aggregated.Type }}) + m.data.{{ $metric.Data.Type }}().SetAggregationTemporality(pmetric.AggregationTemporality{{ $metric.Data.Aggregated }}) {{- end }} {{- if $metric.Attributes }} m.data.{{ $metric.Data.Type }}().DataPoints().EnsureCapacity(m.capacity) diff --git a/cmd/mdatagen/templates/metrics_test.go.tmpl b/cmd/mdatagen/templates/metrics_test.go.tmpl index 4858d6caf569..b73f19f9bf9e 100644 --- a/cmd/mdatagen/templates/metrics_test.go.tmpl +++ b/cmd/mdatagen/templates/metrics_test.go.tmpl @@ -100,7 +100,7 @@ func TestAllMetrics(t *testing.T) { assert.Equal(t, {{ $metric.Data.Monotonic }}, ms.At(i).{{ $metric.Data.Type }}().IsMonotonic()) {{- end }} {{- if $metric.Data.HasAggregated }} - assert.Equal(t, {{ $metric.Data.Aggregated.Type }}, ms.At(i).{{ $metric.Data.Type }}().AggregationTemporality()) + assert.Equal(t, pmetric.AggregationTemporality{{ $metric.Data.Aggregated }}, ms.At(i).{{ $metric.Data.Type }}().AggregationTemporality()) {{- end }} dp := ms.At(i).{{ $metric.Data.Type }}().DataPoints().At(0) assert.Equal(t, start, dp.StartTimestamp()) diff --git a/cmd/mdatagen/testdata/documentation.md b/cmd/mdatagen/testdata/documentation.md deleted file mode 100644 index bbfefb6b08d0..000000000000 --- a/cmd/mdatagen/testdata/documentation.md +++ /dev/null @@ -1,27 +0,0 @@ -[comment]: <> (Code generated by mdatagen. DO NOT EDIT.) - -# metricreceiver - -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **system.cpu.time** | Total CPU seconds broken down by different states. Additional information on CPU Time can be found [here](https://en.wikipedia.org/wiki/CPU_time). | s | Sum(Double) |
  • host
  • cpu_type
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: - -```yaml -metrics: - : - enabled: -``` - -## Metric attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| cpu_type (type) | The type of CPU consumption | user, io_wait, system | -| host | The type of CPU consumption | | diff --git a/receiver/activedirectorydsreceiver/documentation.md b/receiver/activedirectorydsreceiver/documentation.md index 72a41a5bd82a..b4e6de6476ad 100644 --- a/receiver/activedirectorydsreceiver/documentation.md +++ b/receiver/activedirectorydsreceiver/documentation.md @@ -2,48 +2,410 @@ # activedirectorydsreceiver -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **active_directory.ds.bind.rate** | The number of binds per second serviced by this domain controller. | {binds}/s | Sum(Double) |
  • bind_type
| -| **active_directory.ds.ldap.bind.last_successful.time** | The amount of time taken for the last successful LDAP bind. | ms | Gauge(Int) |
| -| **active_directory.ds.ldap.bind.rate** | The number of successful LDAP binds per second. | {binds}/s | Sum(Double) |
| -| **active_directory.ds.ldap.client.session.count** | The number of connected LDAP client sessions. | {sessions} | Sum(Int) |
| -| **active_directory.ds.ldap.search.rate** | The number of LDAP searches per second. | {searches}/s | Sum(Double) |
| -| **active_directory.ds.name_cache.hit_rate** | The percentage of directory object name component lookups that are satisfied by the Directory System Agent's name cache. | % | Gauge(Double) |
| -| **active_directory.ds.notification.queued** | The number of pending update notifications that have been queued to push to clients. | {notifications} | Sum(Int) |
| -| **active_directory.ds.operation.rate** | The number of operations performed per second. | {operations}/s | Sum(Double) |
  • operation_type
| -| **active_directory.ds.replication.network.io** | The amount of network data transmitted by the Directory Replication Agent. | By | Sum(Int) |
  • direction
  • network_data_type
| -| **active_directory.ds.replication.object.rate** | The number of objects transmitted by the Directory Replication Agent per second. | {objects}/s | Sum(Double) |
  • direction
| -| **active_directory.ds.replication.operation.pending** | The number of pending replication operations for the Directory Replication Agent. | {operations} | Sum(Int) |
| -| **active_directory.ds.replication.property.rate** | The number of properties transmitted by the Directory Replication Agent per second. | {properties}/s | Sum(Double) |
  • direction
| -| **active_directory.ds.replication.sync.object.pending** | The number of objects remaining until the full sync completes for the Directory Replication Agent. | {objects} | Sum(Int) |
| -| **active_directory.ds.replication.sync.request.count** | The number of sync requests made by the Directory Replication Agent. | {requests} | Sum(Int) |
  • sync_result
| -| **active_directory.ds.replication.value.rate** | The number of values transmitted by the Directory Replication Agent per second. | {values}/s | Sum(Double) |
  • direction
  • value_type
| -| **active_directory.ds.security_descriptor_propagations_event.queued** | The number of security descriptor propagation events that are queued for processing. | {events} | Sum(Int) |
| -| **active_directory.ds.suboperation.rate** | The rate of sub-operations performed. | {suboperations}/s | Sum(Double) |
  • suboperation_type
| -| **active_directory.ds.thread.count** | The number of threads in use by the directory service. | {threads} | Sum(Int) |
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: + +```yaml +metrics: + : + enabled: false +``` + +### active_directory.ds.bind.rate + +The number of binds per second serviced by this domain controller. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {binds}/s | Sum | Double | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | The type of bind to the domain server. | Str: ``server``, ``client`` | + +### active_directory.ds.ldap.bind.last_successful.time + +The amount of time taken for the last successful LDAP bind. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +### active_directory.ds.ldap.bind.rate + +The number of successful LDAP binds per second. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {binds}/s | Sum | Double | Cumulative | false | + +### active_directory.ds.ldap.client.session.count + +The number of connected LDAP client sessions. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {sessions} | Sum | Int | Cumulative | false | + +### active_directory.ds.ldap.search.rate + +The number of LDAP searches per second. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {searches}/s | Sum | Double | Cumulative | false | + +### active_directory.ds.name_cache.hit_rate + +The percentage of directory object name component lookups that are satisfied by the Directory System Agent's name cache. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +### active_directory.ds.notification.queued + +The number of pending update notifications that have been queued to push to clients. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {notifications} | Sum | Int | Cumulative | false | + +### active_directory.ds.operation.rate + +The number of operations performed per second. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations}/s | Sum | Double | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | The type of operation. | Str: ``read``, ``write``, ``search`` | + +### active_directory.ds.replication.network.io + +The amount of network data transmitted by the Directory Replication Agent. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data flow. | Str: ``sent``, ``received`` | +| type | The type of network data sent. | Str: ``compressed``, ``uncompressed`` | + +### active_directory.ds.replication.object.rate + +The number of objects transmitted by the Directory Replication Agent per second. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {objects}/s | Sum | Double | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data flow. | Str: ``sent``, ``received`` | + +### active_directory.ds.replication.operation.pending + +The number of pending replication operations for the Directory Replication Agent. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | false | + +### active_directory.ds.replication.property.rate + +The number of properties transmitted by the Directory Replication Agent per second. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {properties}/s | Sum | Double | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data flow. | Str: ``sent``, ``received`` | + +### active_directory.ds.replication.sync.object.pending + +The number of objects remaining until the full sync completes for the Directory Replication Agent. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {objects} | Sum | Int | Cumulative | false | + +### active_directory.ds.replication.sync.request.count + +The number of sync requests made by the Directory Replication Agent. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| result | The result status of the sync request. | Str: ``success``, ``schema_mismatch``, ``other`` | + +### active_directory.ds.replication.value.rate + +The number of values transmitted by the Directory Replication Agent per second. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {values}/s | Sum | Double | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data flow. | Str: ``sent``, ``received`` | +| type | The type of value sent. | Str: ``distingushed_names``, ``other`` | + +### active_directory.ds.security_descriptor_propagations_event.queued + +The number of security descriptor propagation events that are queued for processing. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {events} | Sum | Int | Cumulative | false | + +### active_directory.ds.suboperation.rate + +The rate of sub-operations performed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {suboperations}/s | Sum | Double | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | The type of suboperation. | Str: ``security_descriptor_propagations_event``, ``search`` | + +### active_directory.ds.thread.count + +The number of threads in use by the directory service. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {threads} | Sum | Int | Cumulative | false | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Metric attributes +### active_directory.ds.bind.rate + +The number of binds per second serviced by this domain controller. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {binds}/s | Sum | Double | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | The type of bind to the domain server. | Str: ``server``, ``client`` | + +### active_directory.ds.ldap.bind.last_successful.time + +The amount of time taken for the last successful LDAP bind. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +### active_directory.ds.ldap.bind.rate + +The number of successful LDAP binds per second. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {binds}/s | Sum | Double | Cumulative | false | + +### active_directory.ds.ldap.client.session.count + +The number of connected LDAP client sessions. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {sessions} | Sum | Int | Cumulative | false | + +### active_directory.ds.ldap.search.rate + +The number of LDAP searches per second. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {searches}/s | Sum | Double | Cumulative | false | + +### active_directory.ds.name_cache.hit_rate + +The percentage of directory object name component lookups that are satisfied by the Directory System Agent's name cache. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +### active_directory.ds.notification.queued + +The number of pending update notifications that have been queued to push to clients. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {notifications} | Sum | Int | Cumulative | false | + +### active_directory.ds.operation.rate + +The number of operations performed per second. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations}/s | Sum | Double | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | The type of operation. | Str: ``read``, ``write``, ``search`` | + +### active_directory.ds.replication.network.io + +The amount of network data transmitted by the Directory Replication Agent. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data flow. | Str: ``sent``, ``received`` | +| type | The type of network data sent. | Str: ``compressed``, ``uncompressed`` | + +### active_directory.ds.replication.object.rate + +The number of objects transmitted by the Directory Replication Agent per second. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {objects}/s | Sum | Double | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data flow. | Str: ``sent``, ``received`` | + +### active_directory.ds.replication.operation.pending + +The number of pending replication operations for the Directory Replication Agent. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | false | + +### active_directory.ds.replication.property.rate + +The number of properties transmitted by the Directory Replication Agent per second. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {properties}/s | Sum | Double | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data flow. | Str: ``sent``, ``received`` | + +### active_directory.ds.replication.sync.object.pending + +The number of objects remaining until the full sync completes for the Directory Replication Agent. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {objects} | Sum | Int | Cumulative | false | + +### active_directory.ds.replication.sync.request.count + +The number of sync requests made by the Directory Replication Agent. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| result | The result status of the sync request. | Str: ``success``, ``schema_mismatch``, ``other`` | + +### active_directory.ds.replication.value.rate + +The number of values transmitted by the Directory Replication Agent per second. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {values}/s | Sum | Double | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data flow. | Str: ``sent``, ``received`` | +| type | The type of value sent. | Str: ``distingushed_names``, ``other`` | + +### active_directory.ds.security_descriptor_propagations_event.queued + +The number of security descriptor propagation events that are queued for processing. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {events} | Sum | Int | Cumulative | false | + +### active_directory.ds.suboperation.rate + +The rate of sub-operations performed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {suboperations}/s | Sum | Double | Cumulative | false | + +#### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| bind_type (type) | The type of bind to the domain server. | server, client | -| direction | The direction of data flow. | sent, received | -| network_data_type (type) | The type of network data sent. | compressed, uncompressed | -| operation_type (type) | The type of operation. | read, write, search | -| suboperation_type (type) | The type of suboperation. | security_descriptor_propagations_event, search | -| sync_result (result) | The result status of the sync request. | success, schema_mismatch, other | -| value_type (type) | The type of value sent. | distingushed_names, other | +| type | The type of suboperation. | Str: ``security_descriptor_propagations_event``, ``search`` | + +### active_directory.ds.thread.count + +The number of threads in use by the directory service. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {threads} | Sum | Int | Cumulative | false | diff --git a/receiver/aerospikereceiver/documentation.md b/receiver/aerospikereceiver/documentation.md index 00fd6e60db15..fc3803e05e49 100644 --- a/receiver/aerospikereceiver/documentation.md +++ b/receiver/aerospikereceiver/documentation.md @@ -2,54 +2,387 @@ # aerospikereceiver -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **aerospike.namespace.disk.available** | Minimum percentage of contiguous disk space free to the namespace across all devices | % | Gauge(Int) |
| -| **aerospike.namespace.geojson.region_query_cells** | Number of cell coverings for query region queried Number of cell coverings for query region queried. Aerospike metric geo_region_query_cells. | {cells} | Sum(Int) |
| -| **aerospike.namespace.geojson.region_query_false_positive** | Number of points outside the region. Total query result points is geo_region_query_points + geo_region_query_falsepos. Aerospike metric geo_regio_query_falspos. | {points} | Sum(Int) |
| -| **aerospike.namespace.geojson.region_query_points** | Number of points within the region. Total query result points is geo_region_query_points + geo_region_query_falsepos. Aerospike metric geo_region_query_points. | {points} | Sum(Int) |
| -| **aerospike.namespace.geojson.region_query_requests** | Number of geojson queries on the system since the uptime of the node. Number of geojson queries on the system since the uptime of the node. Aerospike metric geo_region_query_reqs. | {queries} | Sum(Int) |
| -| **aerospike.namespace.memory.free** | Percentage of the namespace's memory which is still free Aerospike metric memory_free_pct | % | Gauge(Int) |
| -| **aerospike.namespace.memory.usage** | Memory currently used by each component of the namespace Aggregate of Aerospike Metrics memory_used_data_bytes, memory_used_index_bytes, memory_used_set_index_bytes, memory_used_sindex_bytes | By | Sum(Int) |
  • namespace_component
| -| **aerospike.namespace.query.count** | Number of query operations performed on the namespace Aggregate of Aerospike Metrics query_aggr_abort, query_aggr_complete, query_aggr_error, query_basic_abort, query_basic_complete, query_basic_error, query_ops_bg_abort, query_ops_bg_complete, query_ops_bg_error, query_udf_bg_abort, query_udf_bg_complete, query_udf_bg_error, pi_query_aggr_abort, pi_query_aggr_complete, pi_query_aggr_error, pi_query_long_basic_abort, pi_query_long_basic_complete, pi_query_long_basic_error, pi_query_ops_bg_abort, pi_query_ops_bg_basic_complete, pi_query_ops_bg_basic_error, pi_query_short_basic_timeout, pi_query_short_basic_complete, pi_query_short_basic_error, pi_query_udf_bg_abort, pi_query_udf_bg_complete, pi_query_udf_bg_error, si_query_aggr_abort, si_query_aggr_complete, si_query_aggr_error, si_query_long_basic_abort, si_query_long_basic_complete, si_query_long_basic_error, si_query_ops_bg_abort, si_query_ops_bg_basic_complete, si_query_ops_bg_basic_error, si_query_short_basic_timeout, si_query_short_basic_complete, si_query_short_basic_error, si_query_udf_bg_abort, si_query_udf_bg_complete, si_query_udf_bg_error | {queries} | Sum(Int) |
  • query_type
  • index_type
  • query_result
| -| **aerospike.namespace.scan.count** | Number of scan operations performed on the namespace Aggregate of Aerospike Metrics scan_aggr_abort, scan_aggr_complete, scan_aggr_error, scan_basic_abort, scan_basic_complete, scan_basic_error, scan_ops_bg_abort, scan_ops_bg_complete, scan_ops_bg_error, scan_udf_bg_abort, scan_udf_bg_complete, scan_udf_bg_error | {scans} | Sum(Int) |
  • scan_type
  • scan_result
| -| **aerospike.namespace.transaction.count** | Number of transactions performed on the namespace Aggregate of Aerospike Metrics client_delete_error, client_delete_filtered_out, client_delete_not_found, client_delete_success, client_delete_timeout, client_read_error, client_read_filtered_out, client_read_not_found, client_read_success, client_read_timeout, client_udf_error, client_udf_filtered_out, client_udf_not_found, client_udf_success, client_udf_timeout, client_write_error, client_write_filtered_out, client_write_not_found, client_write_success, client_write_timeout | {transactions} | Sum(Int) |
  • transaction_type
  • transaction_result
| -| **aerospike.node.connection.count** | Number of connections opened and closed to the node Aggregate of Aerospike Metrics client_connections_closed, client_connections_opened, fabric_connections_closed, fabric_connections_opened, heartbeat_connections_closed, heartbeat_connections_opened | {connections} | Sum(Int) |
  • connection_type
  • connection_op
| -| **aerospike.node.connection.open** | Current number of open connections to the node Aggregate of Aerospike Metrics client_connections, fabric_connections, heartbeat_connections | {connections} | Sum(Int) |
  • connection_type
| -| **aerospike.node.memory.free** | Percentage of the node's memory which is still free Aerospike Metric system_free_mem_pct | % | Gauge(Int) |
| -| **aerospike.node.query.tracked** | Number of queries tracked by the system. Number of queries which ran more than query untracked_time (default 1 sec), Aerospike metric query_tracked | | Sum(Int) |
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: + +```yaml +metrics: + : + enabled: false +``` + +### aerospike.namespace.disk.available + +Minimum percentage of contiguous disk space free to the namespace across all devices + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Int | + +### aerospike.namespace.geojson.region_query_cells + +Number of cell coverings for query region queried + +Number of cell coverings for query region queried. Aerospike metric geo_region_query_cells. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {cells} | Sum | Int | Cumulative | true | + +### aerospike.namespace.geojson.region_query_false_positive + +Number of points outside the region. + +Total query result points is geo_region_query_points + geo_region_query_falsepos. Aerospike metric geo_regio_query_falspos. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {points} | Sum | Int | Cumulative | true | + +### aerospike.namespace.geojson.region_query_points + +Number of points within the region. + +Total query result points is geo_region_query_points + geo_region_query_falsepos. Aerospike metric geo_region_query_points. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {points} | Sum | Int | Cumulative | true | + +### aerospike.namespace.geojson.region_query_requests + +Number of geojson queries on the system since the uptime of the node. + +Number of geojson queries on the system since the uptime of the node. Aerospike metric geo_region_query_reqs. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {queries} | Sum | Int | Cumulative | true | + +### aerospike.namespace.memory.free + +Percentage of the namespace's memory which is still free + +Aerospike metric memory_free_pct + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Int | + +### aerospike.namespace.memory.usage + +Memory currently used by each component of the namespace + +Aggregate of Aerospike Metrics memory_used_data_bytes, memory_used_index_bytes, memory_used_set_index_bytes, memory_used_sindex_bytes + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| component | Individual component of a namespace | Str: ``data``, ``index``, ``set_index``, ``secondary_index`` | + +### aerospike.namespace.query.count + +Number of query operations performed on the namespace + +Aggregate of Aerospike Metrics query_aggr_abort, query_aggr_complete, query_aggr_error, query_basic_abort, query_basic_complete, query_basic_error, query_ops_bg_abort, query_ops_bg_complete, query_ops_bg_error, query_udf_bg_abort, query_udf_bg_complete, query_udf_bg_error, pi_query_aggr_abort, pi_query_aggr_complete, pi_query_aggr_error, pi_query_long_basic_abort, pi_query_long_basic_complete, pi_query_long_basic_error, pi_query_ops_bg_abort, pi_query_ops_bg_basic_complete, pi_query_ops_bg_basic_error, pi_query_short_basic_timeout, pi_query_short_basic_complete, pi_query_short_basic_error, pi_query_udf_bg_abort, pi_query_udf_bg_complete, pi_query_udf_bg_error, si_query_aggr_abort, si_query_aggr_complete, si_query_aggr_error, si_query_long_basic_abort, si_query_long_basic_complete, si_query_long_basic_error, si_query_ops_bg_abort, si_query_ops_bg_basic_complete, si_query_ops_bg_basic_error, si_query_short_basic_timeout, si_query_short_basic_complete, si_query_short_basic_error, si_query_udf_bg_abort, si_query_udf_bg_complete, si_query_udf_bg_error + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {queries} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | Type of query operation performed on a namespace | Str: ``aggregation``, ``basic``, ``short``, ``long_basic``, ``short_basic``, ``ops_background``, ``udf_background`` | +| index | Type of index the operation was performed on | Str: ``primary``, ``secondary`` | +| result | Result of a query operation performed on a namespace | Str: ``abort``, ``complete``, ``error``, ``timeout`` | + +### aerospike.namespace.scan.count + +Number of scan operations performed on the namespace + +Aggregate of Aerospike Metrics scan_aggr_abort, scan_aggr_complete, scan_aggr_error, scan_basic_abort, scan_basic_complete, scan_basic_error, scan_ops_bg_abort, scan_ops_bg_complete, scan_ops_bg_error, scan_udf_bg_abort, scan_udf_bg_complete, scan_udf_bg_error + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {scans} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | Type of scan operation performed on a namespace | Str: ``aggregation``, ``basic``, ``ops_background``, ``udf_background`` | +| result | Result of a scan operation performed on a namespace | Str: ``abort``, ``complete``, ``error`` | + +### aerospike.namespace.transaction.count + +Number of transactions performed on the namespace + +Aggregate of Aerospike Metrics client_delete_error, client_delete_filtered_out, client_delete_not_found, client_delete_success, client_delete_timeout, client_read_error, client_read_filtered_out, client_read_not_found, client_read_success, client_read_timeout, client_udf_error, client_udf_filtered_out, client_udf_not_found, client_udf_success, client_udf_timeout, client_write_error, client_write_filtered_out, client_write_not_found, client_write_success, client_write_timeout + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {transactions} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | Type of transaction performed on a namespace | Str: ``delete``, ``read``, ``udf``, ``write`` | +| result | Result of a transaction performed on a namespace | Str: ``error``, ``filtered_out``, ``not_found``, ``success``, ``timeout`` | + +### aerospike.node.connection.count + +Number of connections opened and closed to the node + +Aggregate of Aerospike Metrics client_connections_closed, client_connections_opened, fabric_connections_closed, fabric_connections_opened, heartbeat_connections_closed, heartbeat_connections_opened + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | Type of connection to an Aerospike node | Str: ``client``, ``fabric``, ``heartbeat`` | +| operation | Operation performed with a connection (open or close) | Str: ``close``, ``open`` | + +### aerospike.node.connection.open + +Current number of open connections to the node + +Aggregate of Aerospike Metrics client_connections, fabric_connections, heartbeat_connections + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | Type of connection to an Aerospike node | Str: ``client``, ``fabric``, ``heartbeat`` | + +### aerospike.node.memory.free + +Percentage of the node's memory which is still free + +Aerospike Metric system_free_mem_pct + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Int | + +### aerospike.node.query.tracked + +Number of queries tracked by the system. + +Number of queries which ran more than query untracked_time (default 1 sec), Aerospike metric query_tracked + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | true | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Resource attributes +### aerospike.namespace.disk.available + +Minimum percentage of contiguous disk space free to the namespace across all devices + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Int | + +### aerospike.namespace.geojson.region_query_cells + +Number of cell coverings for query region queried + +Number of cell coverings for query region queried. Aerospike metric geo_region_query_cells. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {cells} | Sum | Int | Cumulative | true | + +### aerospike.namespace.geojson.region_query_false_positive + +Number of points outside the region. + +Total query result points is geo_region_query_points + geo_region_query_falsepos. Aerospike metric geo_regio_query_falspos. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {points} | Sum | Int | Cumulative | true | + +### aerospike.namespace.geojson.region_query_points + +Number of points within the region. + +Total query result points is geo_region_query_points + geo_region_query_falsepos. Aerospike metric geo_region_query_points. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {points} | Sum | Int | Cumulative | true | + +### aerospike.namespace.geojson.region_query_requests + +Number of geojson queries on the system since the uptime of the node. + +Number of geojson queries on the system since the uptime of the node. Aerospike metric geo_region_query_reqs. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {queries} | Sum | Int | Cumulative | true | + +### aerospike.namespace.memory.free + +Percentage of the namespace's memory which is still free + +Aerospike metric memory_free_pct + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Int | + +### aerospike.namespace.memory.usage + +Memory currently used by each component of the namespace + +Aggregate of Aerospike Metrics memory_used_data_bytes, memory_used_index_bytes, memory_used_set_index_bytes, memory_used_sindex_bytes + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| component | Individual component of a namespace | Str: ``data``, ``index``, ``set_index``, ``secondary_index`` | + +### aerospike.namespace.query.count + +Number of query operations performed on the namespace + +Aggregate of Aerospike Metrics query_aggr_abort, query_aggr_complete, query_aggr_error, query_basic_abort, query_basic_complete, query_basic_error, query_ops_bg_abort, query_ops_bg_complete, query_ops_bg_error, query_udf_bg_abort, query_udf_bg_complete, query_udf_bg_error, pi_query_aggr_abort, pi_query_aggr_complete, pi_query_aggr_error, pi_query_long_basic_abort, pi_query_long_basic_complete, pi_query_long_basic_error, pi_query_ops_bg_abort, pi_query_ops_bg_basic_complete, pi_query_ops_bg_basic_error, pi_query_short_basic_timeout, pi_query_short_basic_complete, pi_query_short_basic_error, pi_query_udf_bg_abort, pi_query_udf_bg_complete, pi_query_udf_bg_error, si_query_aggr_abort, si_query_aggr_complete, si_query_aggr_error, si_query_long_basic_abort, si_query_long_basic_complete, si_query_long_basic_error, si_query_ops_bg_abort, si_query_ops_bg_basic_complete, si_query_ops_bg_basic_error, si_query_short_basic_timeout, si_query_short_basic_complete, si_query_short_basic_error, si_query_udf_bg_abort, si_query_udf_bg_complete, si_query_udf_bg_error + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {queries} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | Type of query operation performed on a namespace | Str: ``aggregation``, ``basic``, ``short``, ``long_basic``, ``short_basic``, ``ops_background``, ``udf_background`` | +| index | Type of index the operation was performed on | Str: ``primary``, ``secondary`` | +| result | Result of a query operation performed on a namespace | Str: ``abort``, ``complete``, ``error``, ``timeout`` | + +### aerospike.namespace.scan.count + +Number of scan operations performed on the namespace + +Aggregate of Aerospike Metrics scan_aggr_abort, scan_aggr_complete, scan_aggr_error, scan_basic_abort, scan_basic_complete, scan_basic_error, scan_ops_bg_abort, scan_ops_bg_complete, scan_ops_bg_error, scan_udf_bg_abort, scan_udf_bg_complete, scan_udf_bg_error + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {scans} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | Type of scan operation performed on a namespace | Str: ``aggregation``, ``basic``, ``ops_background``, ``udf_background`` | +| result | Result of a scan operation performed on a namespace | Str: ``abort``, ``complete``, ``error`` | + +### aerospike.namespace.transaction.count + +Number of transactions performed on the namespace + +Aggregate of Aerospike Metrics client_delete_error, client_delete_filtered_out, client_delete_not_found, client_delete_success, client_delete_timeout, client_read_error, client_read_filtered_out, client_read_not_found, client_read_success, client_read_timeout, client_udf_error, client_udf_filtered_out, client_udf_not_found, client_udf_success, client_udf_timeout, client_write_error, client_write_filtered_out, client_write_not_found, client_write_success, client_write_timeout + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {transactions} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | Type of transaction performed on a namespace | Str: ``delete``, ``read``, ``udf``, ``write`` | +| result | Result of a transaction performed on a namespace | Str: ``error``, ``filtered_out``, ``not_found``, ``success``, ``timeout`` | + +### aerospike.node.connection.count + +Number of connections opened and closed to the node + +Aggregate of Aerospike Metrics client_connections_closed, client_connections_opened, fabric_connections_closed, fabric_connections_opened, heartbeat_connections_closed, heartbeat_connections_opened + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | Type of connection to an Aerospike node | Str: ``client``, ``fabric``, ``heartbeat`` | +| operation | Operation performed with a connection (open or close) | Str: ``close``, ``open`` | + +### aerospike.node.connection.open + +Current number of open connections to the node + +Aggregate of Aerospike Metrics client_connections, fabric_connections, heartbeat_connections + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | Type of connection to an Aerospike node | Str: ``client``, ``fabric``, ``heartbeat`` | + +### aerospike.node.memory.free + +Percentage of the node's memory which is still free + +Aerospike Metric system_free_mem_pct + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Int | + +### aerospike.node.query.tracked + +Number of queries tracked by the system. + +Number of queries which ran more than query untracked_time (default 1 sec), Aerospike metric query_tracked -| Name | Description | Type | -| ---- | ----------- | ---- | -| aerospike.namespace | Name of the Aerospike namespace | Str | -| aerospike.node.name | Name of the Aerospike node collected from | Str | +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | true | -## Metric attributes +## Resource Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| connection_op (operation) | Operation performed with a connection (open or close) | close, open | -| connection_type (type) | Type of connection to an Aerospike node | client, fabric, heartbeat | -| index_type (index) | Type of index the operation was performed on | primary, secondary | -| namespace_component (component) | Individual component of a namespace | data, index, set_index, secondary_index | -| query_result (result) | Result of a query operation performed on a namespace | abort, complete, error, timeout | -| query_type (type) | Type of query operation performed on a namespace | aggregation, basic, short, long_basic, short_basic, ops_background, udf_background | -| scan_result (result) | Result of a scan operation performed on a namespace | abort, complete, error | -| scan_type (type) | Type of scan operation performed on a namespace | aggregation, basic, ops_background, udf_background | -| transaction_result (result) | Result of a transaction performed on a namespace | error, filtered_out, not_found, success, timeout | -| transaction_type (type) | Type of transaction performed on a namespace | delete, read, udf, write | +| aerospike.namespace | Name of the Aerospike namespace | Any Str | +| aerospike.node.name | Name of the Aerospike node collected from | Any Str | diff --git a/receiver/apachereceiver/documentation.md b/receiver/apachereceiver/documentation.md index d4f3d8bfe6c5..ec31d6b0a772 100644 --- a/receiver/apachereceiver/documentation.md +++ b/receiver/apachereceiver/documentation.md @@ -2,46 +2,263 @@ # apachereceiver -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **apache.cpu.load** | Current load of the CPU. | % | Gauge(Double) |
| -| **apache.cpu.time** | Jiffs used by processes of given category. | {jiff} | Sum(Double) |
  • cpu_level
  • cpu_mode
| -| **apache.current_connections** | The number of active connections currently attached to the HTTP server. | {connections} | Sum(Int) |
| -| **apache.load.1** | The average server load during the last minute. | % | Gauge(Double) |
| -| **apache.load.15** | The average server load during the last 15 minutes. | % | Gauge(Double) |
| -| **apache.load.5** | The average server load during the last 5 minutes. | % | Gauge(Double) |
| -| **apache.request.time** | Total time spent on handling requests. | ms | Sum(Int) |
| -| **apache.requests** | The number of requests serviced by the HTTP server per second. | {requests} | Sum(Int) |
| -| **apache.scoreboard** | The number of workers in each state. The apache scoreboard is an encoded representation of the state of all the server's workers. This metric decodes the scoreboard and presents a count of workers in each state. Additional details can be found [here](https://metacpan.org/pod/Apache::Scoreboard#DESCRIPTION). | {workers} | Sum(Int) |
  • scoreboard_state
| -| **apache.traffic** | Total HTTP server traffic. | By | Sum(Int) |
| -| **apache.uptime** | The amount of time that the server has been running in seconds. | s | Sum(Int) |
| -| **apache.workers** | The number of workers currently attached to the HTTP server. | {workers} | Sum(Int) |
  • workers_state
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: + +```yaml +metrics: + : + enabled: false +``` + +### apache.cpu.load + +Current load of the CPU. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +### apache.cpu.time + +Jiffs used by processes of given category. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {jiff} | Sum | Double | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| level | Level of processes. | Str: ``self``, ``children`` | +| mode | Mode of processes. | Str: ``system``, ``user`` | + +### apache.current_connections + +The number of active connections currently attached to the HTTP server. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +### apache.load.1 + +The average server load during the last minute. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +### apache.load.15 + +The average server load during the last 15 minutes. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +### apache.load.5 + +The average server load during the last 5 minutes. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +### apache.request.time + +Total time spent on handling requests. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Int | Cumulative | true | + +### apache.requests + +The number of requests serviced by the HTTP server per second. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | true | + +### apache.scoreboard + +The number of workers in each state. + +The apache scoreboard is an encoded representation of the state of all the server's workers. This metric decodes the scoreboard and presents a count of workers in each state. Additional details can be found [here](https://metacpan.org/pod/Apache::Scoreboard#DESCRIPTION). + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {workers} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | The state of a connection. | Str: ``open``, ``waiting``, ``starting``, ``reading``, ``sending``, ``keepalive``, ``dnslookup``, ``closing``, ``logging``, ``finishing``, ``idle_cleanup``, ``unknown`` | + +### apache.traffic + +Total HTTP server traffic. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +### apache.uptime + +The amount of time that the server has been running in seconds. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Int | Cumulative | true | + +### apache.workers + +The number of workers currently attached to the HTTP server. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {workers} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | The state of workers. | Str: ``busy``, ``idle`` | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Resource attributes +### apache.cpu.load + +Current load of the CPU. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +### apache.cpu.time + +Jiffs used by processes of given category. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {jiff} | Sum | Double | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| level | Level of processes. | Str: ``self``, ``children`` | +| mode | Mode of processes. | Str: ``system``, ``user`` | + +### apache.current_connections + +The number of active connections currently attached to the HTTP server. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +### apache.load.1 + +The average server load during the last minute. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +### apache.load.15 + +The average server load during the last 15 minutes. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +### apache.load.5 + +The average server load during the last 5 minutes. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | -| Name | Description | Type | -| ---- | ----------- | ---- | -| apache.server.name | The name of the Apache HTTP server. | Str | -| apache.server.port | The port of the Apache HTTP server. | Str | +### apache.request.time + +Total time spent on handling requests. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Int | Cumulative | true | + +### apache.requests + +The number of requests serviced by the HTTP server per second. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | true | + +### apache.scoreboard + +The number of workers in each state. + +The apache scoreboard is an encoded representation of the state of all the server's workers. This metric decodes the scoreboard and presents a count of workers in each state. Additional details can be found [here](https://metacpan.org/pod/Apache::Scoreboard#DESCRIPTION). + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {workers} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | The state of a connection. | Str: ``open``, ``waiting``, ``starting``, ``reading``, ``sending``, ``keepalive``, ``dnslookup``, ``closing``, ``logging``, ``finishing``, ``idle_cleanup``, ``unknown`` | + +### apache.traffic + +Total HTTP server traffic. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +### apache.uptime + +The amount of time that the server has been running in seconds. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Int | Cumulative | true | + +### apache.workers + +The number of workers currently attached to the HTTP server. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {workers} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | The state of workers. | Str: ``busy``, ``idle`` | -## Metric attributes +## Resource Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| cpu_level (level) | Level of processes. | self, children | -| cpu_mode (mode) | Mode of processes. | system, user | -| scoreboard_state (state) | The state of a connection. | open, waiting, starting, reading, sending, keepalive, dnslookup, closing, logging, finishing, idle_cleanup, unknown | -| workers_state (state) | The state of workers. | busy, idle | +| apache.server.name | The name of the Apache HTTP server. | Any Str | +| apache.server.port | The port of the Apache HTTP server. | Any Str | diff --git a/receiver/bigipreceiver/documentation.md b/receiver/bigipreceiver/documentation.md index 418696d8fe3d..be31a145816f 100644 --- a/receiver/bigipreceiver/documentation.md +++ b/receiver/bigipreceiver/documentation.md @@ -2,66 +2,670 @@ # bigipreceiver -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **bigip.node.availability** | Availability of the node. | 1 | Gauge(Int) |
  • availability.status
| -| **bigip.node.connection.count** | Current number of connections to the node. | {connections} | Sum(Int) |
| -| **bigip.node.data.transmitted** | Amount of data transmitted to and from the node. | By | Sum(Int) |
  • direction
| -| **bigip.node.enabled** | Enabled state of of the node. | 1 | Gauge(Int) |
  • enabled.status
| -| **bigip.node.packet.count** | Number of packets transmitted to and from the node. | {packets} | Sum(Int) |
  • direction
| -| **bigip.node.request.count** | Number of requests to the node. | {requests} | Sum(Int) |
| -| **bigip.node.session.count** | Current number of sessions for the node. | {sessions} | Sum(Int) |
| -| **bigip.pool.availability** | Availability of the pool. | 1 | Gauge(Int) |
  • availability.status
| -| **bigip.pool.connection.count** | Current number of connections to the pool. | {connections} | Sum(Int) |
| -| **bigip.pool.data.transmitted** | Amount of data transmitted to and from the pool. | By | Sum(Int) |
  • direction
| -| **bigip.pool.enabled** | Enabled state of of the pool. | 1 | Gauge(Int) |
  • enabled.status
| -| **bigip.pool.member.count** | Total number of pool members. | {members} | Sum(Int) |
  • active.status
| -| **bigip.pool.packet.count** | Number of packets transmitted to and from the pool. | {packets} | Sum(Int) |
  • direction
| -| **bigip.pool.request.count** | Number of requests to the pool. | {requests} | Sum(Int) |
| -| **bigip.pool_member.availability** | Availability of the pool member. | 1 | Gauge(Int) |
  • availability.status
| -| **bigip.pool_member.connection.count** | Current number of connections to the pool member. | {connections} | Sum(Int) |
| -| **bigip.pool_member.data.transmitted** | Amount of data transmitted to and from the pool member. | By | Sum(Int) |
  • direction
| -| **bigip.pool_member.enabled** | Enabled state of of the pool member. | 1 | Gauge(Int) |
  • enabled.status
| -| **bigip.pool_member.packet.count** | Number of packets transmitted to and from the pool member. | {packets} | Sum(Int) |
  • direction
| -| **bigip.pool_member.request.count** | Number of requests to the pool member. | {requests} | Sum(Int) |
| -| **bigip.pool_member.session.count** | Current number of sessions for the pool member. | {sessions} | Sum(Int) |
| -| **bigip.virtual_server.availability** | Availability of the virtual server. | 1 | Gauge(Int) |
  • availability.status
| -| **bigip.virtual_server.connection.count** | Current number of connections to the virtual server. | {connections} | Sum(Int) |
| -| **bigip.virtual_server.data.transmitted** | Amount of data transmitted to and from the virtual server. | By | Sum(Int) |
  • direction
| -| **bigip.virtual_server.enabled** | Enabled state of of the virtual server. | 1 | Gauge(Int) |
  • enabled.status
| -| **bigip.virtual_server.packet.count** | Number of packets transmitted to and from the virtual server. | {packets} | Sum(Int) |
  • direction
| -| **bigip.virtual_server.request.count** | Number of requests to the virtual server. | {requests} | Sum(Int) |
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: + +```yaml +metrics: + : + enabled: false +``` + +### bigip.node.availability + +Availability of the node. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The availability status. | Str: ``offline``, ``unknown``, ``available`` | + +### bigip.node.connection.count + +Current number of connections to the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +### bigip.node.data.transmitted + +Amount of data transmitted to and from the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data. | Str: ``sent``, ``received`` | + +### bigip.node.enabled + +Enabled state of of the node. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The enabled status. | Str: ``disabled``, ``enabled`` | + +### bigip.node.packet.count + +Number of packets transmitted to and from the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data. | Str: ``sent``, ``received`` | + +### bigip.node.request.count + +Number of requests to the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | true | + +### bigip.node.session.count + +Current number of sessions for the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {sessions} | Sum | Int | Cumulative | false | + +### bigip.pool.availability + +Availability of the pool. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The availability status. | Str: ``offline``, ``unknown``, ``available`` | + +### bigip.pool.connection.count + +Current number of connections to the pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +### bigip.pool.data.transmitted + +Amount of data transmitted to and from the pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data. | Str: ``sent``, ``received`` | + +### bigip.pool.enabled + +Enabled state of of the pool. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The enabled status. | Str: ``disabled``, ``enabled`` | + +### bigip.pool.member.count + +Total number of pool members. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {members} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The active status. | Str: ``active``, ``inactive`` | + +### bigip.pool.packet.count + +Number of packets transmitted to and from the pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data. | Str: ``sent``, ``received`` | + +### bigip.pool.request.count + +Number of requests to the pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | true | + +### bigip.pool_member.availability + +Availability of the pool member. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The availability status. | Str: ``offline``, ``unknown``, ``available`` | + +### bigip.pool_member.connection.count + +Current number of connections to the pool member. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +### bigip.pool_member.data.transmitted + +Amount of data transmitted to and from the pool member. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data. | Str: ``sent``, ``received`` | + +### bigip.pool_member.enabled + +Enabled state of of the pool member. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The enabled status. | Str: ``disabled``, ``enabled`` | + +### bigip.pool_member.packet.count + +Number of packets transmitted to and from the pool member. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data. | Str: ``sent``, ``received`` | + +### bigip.pool_member.request.count + +Number of requests to the pool member. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | true | + +### bigip.pool_member.session.count + +Current number of sessions for the pool member. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {sessions} | Sum | Int | Cumulative | false | + +### bigip.virtual_server.availability + +Availability of the virtual server. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The availability status. | Str: ``offline``, ``unknown``, ``available`` | + +### bigip.virtual_server.connection.count + +Current number of connections to the virtual server. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +### bigip.virtual_server.data.transmitted + +Amount of data transmitted to and from the virtual server. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data. | Str: ``sent``, ``received`` | + +### bigip.virtual_server.enabled + +Enabled state of of the virtual server. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The enabled status. | Str: ``disabled``, ``enabled`` | + +### bigip.virtual_server.packet.count + +Number of packets transmitted to and from the virtual server. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data. | Str: ``sent``, ``received`` | + +### bigip.virtual_server.request.count + +Number of requests to the virtual server. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | true | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Resource attributes +### bigip.node.availability + +Availability of the node. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The availability status. | Str: ``offline``, ``unknown``, ``available`` | + +### bigip.node.connection.count + +Current number of connections to the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +### bigip.node.data.transmitted + +Amount of data transmitted to and from the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data. | Str: ``sent``, ``received`` | + +### bigip.node.enabled + +Enabled state of of the node. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The enabled status. | Str: ``disabled``, ``enabled`` | + +### bigip.node.packet.count + +Number of packets transmitted to and from the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data. | Str: ``sent``, ``received`` | + +### bigip.node.request.count + +Number of requests to the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | true | + +### bigip.node.session.count + +Current number of sessions for the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {sessions} | Sum | Int | Cumulative | false | + +### bigip.pool.availability + +Availability of the pool. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The availability status. | Str: ``offline``, ``unknown``, ``available`` | + +### bigip.pool.connection.count + +Current number of connections to the pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +### bigip.pool.data.transmitted + +Amount of data transmitted to and from the pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data. | Str: ``sent``, ``received`` | + +### bigip.pool.enabled + +Enabled state of of the pool. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The enabled status. | Str: ``disabled``, ``enabled`` | + +### bigip.pool.member.count + +Total number of pool members. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {members} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The active status. | Str: ``active``, ``inactive`` | + +### bigip.pool.packet.count + +Number of packets transmitted to and from the pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data. | Str: ``sent``, ``received`` | + +### bigip.pool.request.count + +Number of requests to the pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | true | + +### bigip.pool_member.availability + +Availability of the pool member. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The availability status. | Str: ``offline``, ``unknown``, ``available`` | + +### bigip.pool_member.connection.count + +Current number of connections to the pool member. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +### bigip.pool_member.data.transmitted + +Amount of data transmitted to and from the pool member. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data. | Str: ``sent``, ``received`` | + +### bigip.pool_member.enabled + +Enabled state of of the pool member. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The enabled status. | Str: ``disabled``, ``enabled`` | + +### bigip.pool_member.packet.count + +Number of packets transmitted to and from the pool member. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data. | Str: ``sent``, ``received`` | + +### bigip.pool_member.request.count + +Number of requests to the pool member. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | true | + +### bigip.pool_member.session.count + +Current number of sessions for the pool member. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {sessions} | Sum | Int | Cumulative | false | + +### bigip.virtual_server.availability + +Availability of the virtual server. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The availability status. | Str: ``offline``, ``unknown``, ``available`` | + +### bigip.virtual_server.connection.count + +Current number of connections to the virtual server. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +### bigip.virtual_server.data.transmitted + +Amount of data transmitted to and from the virtual server. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data. | Str: ``sent``, ``received`` | + +### bigip.virtual_server.enabled + +Enabled state of of the virtual server. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The enabled status. | Str: ``disabled``, ``enabled`` | + +### bigip.virtual_server.packet.count + +Number of packets transmitted to and from the virtual server. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of data. | Str: ``sent``, ``received`` | + +### bigip.virtual_server.request.count + +Number of requests to the virtual server. -| Name | Description | Type | -| ---- | ----------- | ---- | -| bigip.node.ip_address | The IP Address of the Big-IP Node. | Str | -| bigip.node.name | The name of the Big-IP Node. | Str | -| bigip.pool.name | The name of the Big-IP Pool. | Str | -| bigip.pool_member.ip_address | The IP Address of the Big-IP Pool Member. | Str | -| bigip.pool_member.name | The name of the Big-IP Pool Member. | Str | -| bigip.virtual_server.destination | The destination for the Big-IP Virtual Server. | Str | -| bigip.virtual_server.name | The name of the Big-IP Virtual Server. | Str | +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | true | -## Metric attributes +## Resource Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| active.status (status) | The active status. | active, inactive | -| availability.status (status) | The availability status. | offline, unknown, available | -| direction (direction) | The direction of data. | sent, received | -| enabled.status (status) | The enabled status. | disabled, enabled | +| bigip.node.ip_address | The IP Address of the Big-IP Node. | Any Str | +| bigip.node.name | The name of the Big-IP Node. | Any Str | +| bigip.pool.name | The name of the Big-IP Pool. | Any Str | +| bigip.pool_member.ip_address | The IP Address of the Big-IP Pool Member. | Any Str | +| bigip.pool_member.name | The name of the Big-IP Pool Member. | Any Str | +| bigip.virtual_server.destination | The destination for the Big-IP Virtual Server. | Any Str | +| bigip.virtual_server.name | The name of the Big-IP Virtual Server. | Any Str | diff --git a/receiver/chronyreceiver/documentation.md b/receiver/chronyreceiver/documentation.md index 325257b7188a..9bf1f81d14b8 100644 --- a/receiver/chronyreceiver/documentation.md +++ b/receiver/chronyreceiver/documentation.md @@ -2,31 +2,94 @@ # chrony receiver -## Metrics +## Default Metrics -These are the metrics available for this scraper. +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| ntp.frequency.offset | The frequency is the rate by which the system s clock would be wrong if chronyd was not correcting it. It is expressed in ppm (parts per million). For example, a value of 1 ppm would mean that when the system’s clock thinks it has advanced 1 second, it has actually advanced by 1.000001 seconds relative to true time. | ppm | Gauge(Double) |
  • leap.status
| -| **ntp.skew** | This is the estimated error bound on the frequency. | ppm | Gauge(Double) |
| -| ntp.stratum | The number of hops away from the reference system keeping the reference time To read further, refer to https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/system_administrators_guide/ch-configuring_ntp_using_the_chrony_suite#sect-Checking_chrony_tracking | {count} | Gauge(Int) |
| -| **ntp.time.correction** | The number of seconds difference between the system's clock and the reference clock | seconds | Gauge(Double) |
  • leap.status
| -| **ntp.time.last_offset** | The estimated local offset on the last clock update | seconds | Gauge(Double) |
  • leap.status
| -| ntp.time.rms_offset | the long term average of the offset value | seconds | Gauge(Double) |
  • leap.status
| -| ntp.time.root_delay | This is the total of the network path delays to the stratum-1 system from which the system is ultimately synchronised. | seconds | Gauge(Double) |
  • leap.status
| +```yaml +metrics: + : + enabled: false +``` + +### ntp.skew + +This is the estimated error bound on the frequency. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ppm | Gauge | Double | + +### ntp.time.correction + +The number of seconds difference between the system's clock and the reference clock -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| seconds | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| leap.status | how the chrony is handling leap seconds | Str: ``normal``, ``insert_second``, ``delete_second``, ``unsynchronised`` | + +### ntp.time.last_offset + +The estimated local offset on the last clock update + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| seconds | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| leap.status | how the chrony is handling leap seconds | Str: ``normal``, ``insert_second``, ``delete_second``, ``unsynchronised`` | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Metric attributes +### ntp.skew + +This is the estimated error bound on the frequency. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ppm | Gauge | Double | + +### ntp.time.correction + +The number of seconds difference between the system's clock and the reference clock + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| seconds | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| leap.status | how the chrony is handling leap seconds | Str: ``normal``, ``insert_second``, ``delete_second``, ``unsynchronised`` | + +### ntp.time.last_offset + +The estimated local offset on the last clock update + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| seconds | Gauge | Double | + +#### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| leap.status | how the chrony is handling leap seconds | normal, insert_second, delete_second, unsynchronised | +| leap.status | how the chrony is handling leap seconds | Str: ``normal``, ``insert_second``, ``delete_second``, ``unsynchronised`` | diff --git a/receiver/couchdbreceiver/documentation.md b/receiver/couchdbreceiver/documentation.md index beeb16ddab90..d33fc897e648 100644 --- a/receiver/couchdbreceiver/documentation.md +++ b/receiver/couchdbreceiver/documentation.md @@ -2,41 +2,204 @@ # couchdbreceiver -## Metrics +## Default Metrics -These are the metrics available for this scraper. +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **couchdb.average_request_time** | The average duration of a served request. | ms | Gauge(Double) |
| -| **couchdb.database.open** | The number of open databases. | {databases} | Sum(Int) |
| -| **couchdb.database.operations** | The number of database operations. | {operations} | Sum(Int) |
  • operation
| -| **couchdb.file_descriptor.open** | The number of open file descriptors. | {files} | Sum(Int) |
| -| **couchdb.httpd.bulk_requests** | The number of bulk requests. | {requests} | Sum(Int) |
| -| **couchdb.httpd.requests** | The number of HTTP requests by method. | {requests} | Sum(Int) |
  • http.method
| -| **couchdb.httpd.responses** | The number of each HTTP status code. | {responses} | Sum(Int) |
  • http.status_code
| -| **couchdb.httpd.views** | The number of views read. | {views} | Sum(Int) |
  • view
| +```yaml +metrics: + : + enabled: false +``` + +### couchdb.average_request_time + +The average duration of a served request. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Double | + +### couchdb.database.open + +The number of open databases. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {databases} | Sum | Int | Cumulative | false | + +### couchdb.database.operations + +The number of database operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The operation type. | Str: ``writes``, ``reads`` | + +### couchdb.file_descriptor.open + +The number of open file descriptors. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {files} | Sum | Int | Cumulative | false | + +### couchdb.httpd.bulk_requests -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +The number of bulk requests. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | true | + +### couchdb.httpd.requests + +The number of HTTP requests by method. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| http.method | An HTTP request method. | Str: ``COPY``, ``DELETE``, ``GET``, ``HEAD``, ``OPTIONS``, ``POST``, ``PUT`` | + +### couchdb.httpd.responses + +The number of each HTTP status code. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {responses} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| http.status_code | An HTTP status code. | Any Str | + +### couchdb.httpd.views + +The number of views read. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {views} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| view | The view type. | Str: ``temporary_view_reads``, ``view_reads`` | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Resource attributes +### couchdb.average_request_time + +The average duration of a served request. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Double | + +### couchdb.database.open + +The number of open databases. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {databases} | Sum | Int | Cumulative | false | + +### couchdb.database.operations + +The number of database operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The operation type. | Str: ``writes``, ``reads`` | + +### couchdb.file_descriptor.open + +The number of open file descriptors. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {files} | Sum | Int | Cumulative | false | + +### couchdb.httpd.bulk_requests + +The number of bulk requests. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | true | -| Name | Description | Type | -| ---- | ----------- | ---- | -| couchdb.node.name | The name of the node. | Str | +### couchdb.httpd.requests + +The number of HTTP requests by method. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| http.method | An HTTP request method. | Str: ``COPY``, ``DELETE``, ``GET``, ``HEAD``, ``OPTIONS``, ``POST``, ``PUT`` | + +### couchdb.httpd.responses + +The number of each HTTP status code. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {responses} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| http.status_code | An HTTP status code. | Any Str | + +### couchdb.httpd.views + +The number of views read. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {views} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| view | The view type. | Str: ``temporary_view_reads``, ``view_reads`` | -## Metric attributes +## Resource Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| http.method | An HTTP request method. | COPY, DELETE, GET, HEAD, OPTIONS, POST, PUT | -| http.status_code | An HTTP status code. | | -| operation | The operation type. | writes, reads | -| view | The view type. | temporary_view_reads, view_reads | +| couchdb.node.name | The name of the node. | Any Str | diff --git a/receiver/dockerstatsreceiver/documentation.md b/receiver/dockerstatsreceiver/documentation.md index fc5928394792..f5d3641e4594 100644 --- a/receiver/dockerstatsreceiver/documentation.md +++ b/receiver/dockerstatsreceiver/documentation.md @@ -2,101 +2,308 @@ # dockerstatsreceiver -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| container.blockio.io_merged_recursive | Number of bios/requests merged into requests belonging to this cgroup and its descendant cgroups. [More docs](https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt). | {operations} | Sum(Int) |
  • device_major
  • device_minor
  • operation
| -| container.blockio.io_queued_recursive | Number of requests queued up for this cgroup and its descendant cgroups. [More docs](https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt). | {operations} | Sum(Int) |
  • device_major
  • device_minor
  • operation
| -| **container.blockio.io_service_bytes_recursive** | Number of bytes transferred to/from the disk by the group and descendant groups. [More docs](https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt). | By | Sum(Int) |
  • device_major
  • device_minor
  • operation
| -| container.blockio.io_service_time_recursive | Total amount of time in nanoseconds between request dispatch and request completion for the IOs done by this cgroup and descendant cgroups. [More docs](https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt). | ns | Sum(Int) |
  • device_major
  • device_minor
  • operation
| -| container.blockio.io_serviced_recursive | Number of IOs (bio) issued to the disk by the group and descendant groups. [More docs](https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt). | {operations} | Sum(Int) |
  • device_major
  • device_minor
  • operation
| -| container.blockio.io_time_recursive | Disk time allocated to cgroup (and descendant cgroups) per device in milliseconds. [More docs](https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt). | ms | Sum(Int) |
  • device_major
  • device_minor
  • operation
| -| container.blockio.io_wait_time_recursive | Total amount of time the IOs for this cgroup (and descendant cgroups) spent waiting in the scheduler queues for service. [More docs](https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt). | ns | Sum(Int) |
  • device_major
  • device_minor
  • operation
| -| container.blockio.sectors_recursive | Number of sectors transferred to/from disk by the group and descendant groups. [More docs](https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt). | {sectors} | Sum(Int) |
  • device_major
  • device_minor
  • operation
| -| **container.cpu.percent** | Percent of CPU used by the container. | 1 | Gauge(Double) |
| -| container.cpu.throttling_data.periods | Number of periods with throttling active. | {periods} | Sum(Int) |
| -| container.cpu.throttling_data.throttled_periods | Number of periods when the container hits its throttling limit. | {periods} | Sum(Int) |
| -| container.cpu.throttling_data.throttled_time | Aggregate time the container was throttled. | ns | Sum(Int) |
| -| **container.cpu.usage.kernelmode** | Time spent by tasks of the cgroup in kernel mode (Linux). Time spent by all container processes in kernel mode (Windows). | ns | Sum(Int) |
| -| container.cpu.usage.percpu | Per-core CPU usage by the container. | ns | Sum(Int) |
  • core
| -| container.cpu.usage.system | System CPU usage, as reported by docker. Note this is the usage for the system, not the container. | ns | Sum(Int) |
| -| **container.cpu.usage.total** | Total CPU time consumed. | ns | Sum(Int) |
| -| **container.cpu.usage.usermode** | Time spent by tasks of the cgroup in user mode (Linux). Time spent by all container processes in user mode (Windows). | ns | Sum(Int) |
| -| container.memory.active_anon | The amount of anonymous memory that has been identified as active by the kernel. | By | Sum(Int) |
| -| container.memory.active_file | Cache memory that has been identified as active by the kernel. [More docs](https://docs.docker.com/config/containers/runmetrics/) | By | Sum(Int) |
| -| container.memory.cache | The amount of memory used by the processes of this control group that can be associated precisely with a block on a block device. | By | Sum(Int) |
| -| container.memory.dirty | Bytes that are waiting to get written back to the disk, from this cgroup. | By | Sum(Int) |
| -| container.memory.hierarchical_memory_limit | The maximum amount of physical memory that can be used by the processes of this control group. | By | Sum(Int) |
| -| container.memory.hierarchical_memsw_limit | The maximum amount of RAM + swap that can be used by the processes of this control group. | By | Sum(Int) |
| -| container.memory.inactive_anon | The amount of anonymous memory that has been identified as inactive by the kernel. | By | Sum(Int) |
| -| container.memory.inactive_file | Cache memory that has been identified as inactive by the kernel. [More docs](https://docs.docker.com/config/containers/runmetrics/) | By | Sum(Int) |
| -| container.memory.mapped_file | Indicates the amount of memory mapped by the processes in the control group. | By | Sum(Int) |
| -| **container.memory.percent** | Percentage of memory used. | 1 | Gauge(Double) |
| -| container.memory.pgfault | Indicate the number of times that a process of the cgroup triggered a page fault. | {faults} | Sum(Int) |
| -| container.memory.pgmajfault | Indicate the number of times that a process of the cgroup triggered a major fault. | {faults} | Sum(Int) |
| -| container.memory.pgpgin | Number of pages read from disk by the cgroup. [More docs](https://www.kernel.org/doc/Documentation/cgroup-v1/memory.txt). | {operations} | Sum(Int) |
| -| container.memory.pgpgout | Number of pages written to disk by the cgroup. [More docs](https://www.kernel.org/doc/Documentation/cgroup-v1/memory.txt). | {operations} | Sum(Int) |
| -| container.memory.rss | The amount of memory that doesn’t correspond to anything on disk: stacks, heaps, and anonymous memory maps. | By | Sum(Int) |
| -| container.memory.rss_huge | Number of bytes of anonymous transparent hugepages in this cgroup. | By | Sum(Int) |
| -| container.memory.swap | The amount of swap currently used by the processes in this cgroup. | By | Sum(Int) |
| -| container.memory.total_active_anon | The amount of anonymous memory that has been identified as active by the kernel. Includes descendant cgroups. | By | Sum(Int) |
| -| container.memory.total_active_file | Cache memory that has been identified as active by the kernel. Includes descendant cgroups. [More docs](https://docs.docker.com/config/containers/runmetrics/). | By | Sum(Int) |
| -| **container.memory.total_cache** | Total amount of memory used by the processes of this cgroup (and descendants) that can be associated with a block on a block device. Also accounts for memory used by tmpfs. | By | Sum(Int) |
| -| container.memory.total_dirty | Bytes that are waiting to get written back to the disk, from this cgroup and descendants. | By | Sum(Int) |
| -| container.memory.total_inactive_anon | The amount of anonymous memory that has been identified as inactive by the kernel. Includes descendant cgroups. | By | Sum(Int) |
| -| container.memory.total_inactive_file | Cache memory that has been identified as inactive by the kernel. Includes descendant cgroups. [More docs](https://docs.docker.com/config/containers/runmetrics/). | By | Sum(Int) |
| -| container.memory.total_mapped_file | Indicates the amount of memory mapped by the processes in the control group and descendant groups. | By | Sum(Int) |
| -| container.memory.total_pgfault | Indicate the number of times that a process of the cgroup (or descendant cgroups) triggered a page fault. | {faults} | Sum(Int) |
| -| container.memory.total_pgmajfault | Indicate the number of times that a process of the cgroup (or descendant cgroups) triggered a major fault. | {faults} | Sum(Int) |
| -| container.memory.total_pgpgin | Number of pages read from disk by the cgroup and descendant groups. | {operations} | Sum(Int) |
| -| container.memory.total_pgpgout | Number of pages written to disk by the cgroup and descendant groups. | {operations} | Sum(Int) |
| -| container.memory.total_rss | The amount of memory that doesn’t correspond to anything on disk: stacks, heaps, and anonymous memory maps. Includes descendant cgroups. | By | Sum(Int) |
| -| container.memory.total_rss_huge | Number of bytes of anonymous transparent hugepages in this cgroup and descendant cgroups. | By | Sum(Int) |
| -| container.memory.total_swap | The amount of swap currently used by the processes in this cgroup and descendant groups. | By | Sum(Int) |
| -| container.memory.total_unevictable | The amount of memory that cannot be reclaimed. Includes descendant cgroups. | By | Sum(Int) |
| -| container.memory.total_writeback | Number of bytes of file/anon cache that are queued for syncing to disk in this cgroup and descendants. | By | Sum(Int) |
| -| container.memory.unevictable | The amount of memory that cannot be reclaimed. | By | Sum(Int) |
| -| **container.memory.usage.limit** | Memory limit of the container. | By | Sum(Int) |
| -| container.memory.usage.max | Maximum memory usage. | By | Sum(Int) |
| -| **container.memory.usage.total** | Memory usage of the container. This excludes the total cache. | By | Sum(Int) |
| -| container.memory.writeback | Number of bytes of file/anon cache that are queued for syncing to disk in this cgroup. | By | Sum(Int) |
| -| **container.network.io.usage.rx_bytes** | Bytes received by the container. | By | Sum(Int) |
  • interface
| -| **container.network.io.usage.rx_dropped** | Incoming packets dropped. | {packets} | Sum(Int) |
  • interface
| -| container.network.io.usage.rx_errors | Received errors. | {errors} | Sum(Int) |
  • interface
| -| container.network.io.usage.rx_packets | Packets received. | {packets} | Sum(Int) |
  • interface
| -| **container.network.io.usage.tx_bytes** | Bytes sent. | By | Sum(Int) |
  • interface
| -| **container.network.io.usage.tx_dropped** | Outgoing packets dropped. | {packets} | Sum(Int) |
  • interface
| -| container.network.io.usage.tx_errors | Sent errors. | {errors} | Sum(Int) |
  • interface
| -| container.network.io.usage.tx_packets | Packets sent. | {packets} | Sum(Int) |
  • interface
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: + +```yaml +metrics: + : + enabled: false +``` + +### container.blockio.io_service_bytes_recursive + +Number of bytes transferred to/from the disk by the group and descendant groups. + +[More docs](https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt). + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device_major | Device major number for block IO operations. | Any Str | +| device_minor | Device minor number for block IO operations. | Any Str | +| operation | Type of BlockIO operation. | Any Str | + +### container.cpu.percent + +Percent of CPU used by the container. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### container.cpu.usage.kernelmode + +Time spent by tasks of the cgroup in kernel mode (Linux). Time spent by all container processes in kernel mode (Windows). + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ns | Sum | Int | Cumulative | true | + +### container.cpu.usage.total + +Total CPU time consumed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ns | Sum | Int | Cumulative | true | + +### container.cpu.usage.usermode + +Time spent by tasks of the cgroup in user mode (Linux). Time spent by all container processes in user mode (Windows). + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ns | Sum | Int | Cumulative | true | + +### container.memory.percent + +Percentage of memory used. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### container.memory.total_cache + +Total amount of memory used by the processes of this cgroup (and descendants) that can be associated with a block on a block device. Also accounts for memory used by tmpfs. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.usage.limit + +Memory limit of the container. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.usage.total + +Memory usage of the container. This excludes the total cache. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.network.io.usage.rx_bytes + +Bytes received by the container. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| interface | Network interface. | Any Str | + +### container.network.io.usage.rx_dropped + +Incoming packets dropped. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| interface | Network interface. | Any Str | + +### container.network.io.usage.tx_bytes + +Bytes sent. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| interface | Network interface. | Any Str | + +### container.network.io.usage.tx_dropped + +Outgoing packets dropped. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| interface | Network interface. | Any Str | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Resource attributes +### container.blockio.io_service_bytes_recursive + +Number of bytes transferred to/from the disk by the group and descendant groups. + +[More docs](https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt). + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device_major | Device major number for block IO operations. | Any Str | +| device_minor | Device minor number for block IO operations. | Any Str | +| operation | Type of BlockIO operation. | Any Str | + +### container.cpu.percent + +Percent of CPU used by the container. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### container.cpu.usage.kernelmode + +Time spent by tasks of the cgroup in kernel mode (Linux). Time spent by all container processes in kernel mode (Windows). + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ns | Sum | Int | Cumulative | true | + +### container.cpu.usage.total + +Total CPU time consumed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ns | Sum | Int | Cumulative | true | + +### container.cpu.usage.usermode + +Time spent by tasks of the cgroup in user mode (Linux). Time spent by all container processes in user mode (Windows). + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ns | Sum | Int | Cumulative | true | + +### container.memory.percent + +Percentage of memory used. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### container.memory.total_cache + +Total amount of memory used by the processes of this cgroup (and descendants) that can be associated with a block on a block device. Also accounts for memory used by tmpfs. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.usage.limit + +Memory limit of the container. -| Name | Description | Type | -| ---- | ----------- | ---- | -| container.hostname | The hostname of the container. | Str | -| container.id | The ID of the container. | Str | -| container.image.name | The name of the docker image in use by the container. | Str | -| container.name | The name of the container. | Str | -| container.runtime | The runtime of the container. For this receiver, it will always be 'docker'. | Str | +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.memory.usage.total + +Memory usage of the container. This excludes the total cache. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### container.network.io.usage.rx_bytes + +Bytes received by the container. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| interface | Network interface. | Any Str | + +### container.network.io.usage.rx_dropped + +Incoming packets dropped. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| interface | Network interface. | Any Str | + +### container.network.io.usage.tx_bytes + +Bytes sent. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| interface | Network interface. | Any Str | + +### container.network.io.usage.tx_dropped + +Outgoing packets dropped. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| interface | Network interface. | Any Str | -## Metric attributes +## Resource Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| core | The CPU core number when utilising per-CPU metrics. | | -| device_major | Device major number for block IO operations. | | -| device_minor | Device minor number for block IO operations. | | -| interface | Network interface. | | -| operation | Type of BlockIO operation. | | +| container.hostname | The hostname of the container. | Any Str | +| container.id | The ID of the container. | Any Str | +| container.image.name | The name of the docker image in use by the container. | Any Str | +| container.name | The name of the container. | Any Str | +| container.runtime | The runtime of the container. For this receiver, it will always be 'docker'. | Any Str | diff --git a/receiver/elasticsearchreceiver/documentation.md b/receiver/elasticsearchreceiver/documentation.md index a05eb9f8f562..225e483bb2a0 100644 --- a/receiver/elasticsearchreceiver/documentation.md +++ b/receiver/elasticsearchreceiver/documentation.md @@ -2,141 +2,1536 @@ # elasticsearchreceiver -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **elasticsearch.breaker.memory.estimated** | Estimated memory used for the operation. | By | Gauge(Int) |
  • circuit_breaker_name
| -| **elasticsearch.breaker.memory.limit** | Memory limit for the circuit breaker. | By | Sum(Int) |
  • circuit_breaker_name
| -| **elasticsearch.breaker.tripped** | Total number of times the circuit breaker has been triggered and prevented an out of memory error. | 1 | Sum(Int) |
  • circuit_breaker_name
| -| **elasticsearch.cluster.data_nodes** | The number of data nodes in the cluster. | {nodes} | Sum(Int) |
| -| **elasticsearch.cluster.health** | The health status of the cluster. Health status is based on the state of its primary and replica shards. Green indicates all shards are assigned. Yellow indicates that one or more replica shards are unassigned. Red indicates that one or more primary shards are unassigned, making some data unavailable. | {status} | Sum(Int) |
  • health_status
| -| **elasticsearch.cluster.in_flight_fetch** | The number of unfinished fetches. | {fetches} | Sum(Int) |
| -| **elasticsearch.cluster.nodes** | The total number of nodes in the cluster. | {nodes} | Sum(Int) |
| -| **elasticsearch.cluster.pending_tasks** | The number of cluster-level changes that have not yet been executed. | {tasks} | Sum(Int) |
| -| **elasticsearch.cluster.published_states.differences** | Number of differences between published cluster states. | 1 | Sum(Int) |
  • cluster_published_difference_state
| -| **elasticsearch.cluster.published_states.full** | Number of published cluster states. | 1 | Sum(Int) |
| -| **elasticsearch.cluster.shards** | The number of shards in the cluster. | {shards} | Sum(Int) |
  • shard_state
| -| **elasticsearch.cluster.state_queue** | Number of cluster states in queue. | 1 | Sum(Int) |
  • cluster_state_queue_state
| -| **elasticsearch.cluster.state_update.count** | The number of cluster state update attempts that changed the cluster state since the node started. | 1 | Sum(Int) |
  • cluster_state_update_state
| -| **elasticsearch.cluster.state_update.time** | The cumulative amount of time updating the cluster state since the node started. | ms | Sum(Int) |
  • cluster_state_update_state
  • cluster_state_update_type
| -| elasticsearch.index.cache.evictions | The number of evictions from the cache for an index. | {evictions} | Sum(Int) |
  • cache_name
  • index_aggregation_type
| -| elasticsearch.index.cache.memory.usage | The size in bytes of the cache for an index. | By | Sum(Int) |
  • cache_name
  • index_aggregation_type
| -| elasticsearch.index.cache.size | The number of elements of the query cache for an index. | 1 | Sum(Int) |
  • index_aggregation_type
| -| elasticsearch.index.documents | The number of documents for an index. | {documents} | Sum(Int) |
  • document_state
  • index_aggregation_type
| -| **elasticsearch.index.operations.completed** | The number of operations completed for an index. | {operations} | Sum(Int) |
  • operation
  • index_aggregation_type
| -| elasticsearch.index.operations.merge.docs_count | The total number of documents in merge operations for an index. | {documents} | Sum(Int) |
  • index_aggregation_type
| -| elasticsearch.index.operations.merge.size | The total size of merged segments for an index. | By | Sum(Int) |
  • index_aggregation_type
| -| **elasticsearch.index.operations.time** | Time spent on operations for an index. | ms | Sum(Int) |
  • operation
  • index_aggregation_type
| -| elasticsearch.index.segments.count | Number of segments of an index. | {segments} | Sum(Int) |
  • index_aggregation_type
| -| elasticsearch.index.segments.memory | Size of memory for segment object of an index. | By | Sum(Int) |
  • index_aggregation_type
  • segments_memory_object_type
| -| elasticsearch.index.segments.size | Size of segments of an index. | By | Sum(Int) |
  • index_aggregation_type
| -| **elasticsearch.index.shards.size** | The size of the shards assigned to this index. | By | Sum(Int) |
  • index_aggregation_type
| -| elasticsearch.index.translog.operations | Number of transaction log operations for an index. | {operations} | Sum(Int) |
  • index_aggregation_type
| -| elasticsearch.index.translog.size | Size of the transaction log for an index. | By | Sum(Int) |
  • index_aggregation_type
| -| **elasticsearch.indexing_pressure.memory.limit** | Configured memory limit, in bytes, for the indexing requests. | By | Gauge(Int) |
| -| **elasticsearch.indexing_pressure.memory.total.primary_rejections** | Cumulative number of indexing requests rejected in the primary stage. | 1 | Sum(Int) |
| -| **elasticsearch.indexing_pressure.memory.total.replica_rejections** | Number of indexing requests rejected in the replica stage. | 1 | Sum(Int) |
| -| **elasticsearch.memory.indexing_pressure** | Memory consumed, in bytes, by indexing requests in the specified stage. | By | Sum(Int) |
  • indexing_pressure_stage
| -| **elasticsearch.node.cache.count** | Total count of query cache misses across all shards assigned to selected nodes. | {count} | Sum(Int) |
  • query_cache_count_type
| -| **elasticsearch.node.cache.evictions** | The number of evictions from the cache on a node. | {evictions} | Sum(Int) |
  • cache_name
| -| **elasticsearch.node.cache.memory.usage** | The size in bytes of the cache on a node. | By | Sum(Int) |
  • cache_name
| -| **elasticsearch.node.cluster.connections** | The number of open tcp connections for internal cluster communication. | {connections} | Sum(Int) |
| -| **elasticsearch.node.cluster.io** | The number of bytes sent and received on the network for internal cluster communication. | By | Sum(Int) |
  • direction
| -| **elasticsearch.node.disk.io.read** | The total number of kilobytes read across all file stores for this node. | KiBy | Sum(Int) |
| -| **elasticsearch.node.disk.io.write** | The total number of kilobytes written across all file stores for this node. | KiBy | Sum(Int) |
| -| **elasticsearch.node.documents** | The number of documents on the node. | {documents} | Sum(Int) |
  • document_state
| -| **elasticsearch.node.fs.disk.available** | The amount of disk space available to the JVM across all file stores for this node. Depending on OS or process level restrictions, this might appear less than free. This is the actual amount of free disk space the Elasticsearch node can utilise. | By | Sum(Int) |
| -| **elasticsearch.node.fs.disk.free** | The amount of unallocated disk space across all file stores for this node. | By | Sum(Int) |
| -| **elasticsearch.node.fs.disk.total** | The amount of disk space across all file stores for this node. | By | Sum(Int) |
| -| **elasticsearch.node.http.connections** | The number of HTTP connections to the node. | {connections} | Sum(Int) |
| -| **elasticsearch.node.ingest.documents** | Total number of documents ingested during the lifetime of this node. | {documents} | Sum(Int) |
| -| **elasticsearch.node.ingest.documents.current** | Total number of documents currently being ingested. | {documents} | Sum(Int) |
| -| **elasticsearch.node.ingest.operations.failed** | Total number of failed ingest operations during the lifetime of this node. | {operation} | Sum(Int) |
| -| **elasticsearch.node.open_files** | The number of open file descriptors held by the node. | {files} | Sum(Int) |
| -| **elasticsearch.node.operations.completed** | The number of operations completed by a node. | {operations} | Sum(Int) |
  • operation
| -| elasticsearch.node.operations.get.completed | The number of hits and misses resulting from GET operations. | {operations} | Sum(Int) |
  • get_result
| -| elasticsearch.node.operations.get.time | The time spent on hits and misses resulting from GET operations. | ms | Sum(Int) |
  • get_result
| -| **elasticsearch.node.operations.time** | Time spent on operations by a node. | ms | Sum(Int) |
  • operation
| -| **elasticsearch.node.pipeline.ingest.documents.current** | Total number of documents currently being ingested by a pipeline. | {documents} | Sum(Int) |
  • ingest_pipeline_name
| -| **elasticsearch.node.pipeline.ingest.documents.preprocessed** | Number of documents preprocessed by the ingest pipeline. | {documents} | Sum(Int) |
  • ingest_pipeline_name
| -| **elasticsearch.node.pipeline.ingest.operations.failed** | Total number of failed operations for the ingest pipeline. | {operation} | Sum(Int) |
  • ingest_pipeline_name
| -| **elasticsearch.node.script.cache_evictions** | Total number of times the script cache has evicted old data. | 1 | Sum(Int) |
| -| **elasticsearch.node.script.compilation_limit_triggered** | Total number of times the script compilation circuit breaker has limited inline script compilations. | 1 | Sum(Int) |
| -| **elasticsearch.node.script.compilations** | Total number of inline script compilations performed by the node. | {compilations} | Sum(Int) |
| -| elasticsearch.node.segments.memory | Size of memory for segment object of a node. | By | Sum(Int) |
  • segments_memory_object_type
| -| **elasticsearch.node.shards.data_set.size** | Total data set size of all shards assigned to the node. This includes the size of shards not stored fully on the node, such as the cache for partially mounted indices. | By | Sum(Int) |
| -| **elasticsearch.node.shards.reserved.size** | A prediction of how much larger the shard stores on this node will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. A value of -1 indicates that this is not available. | By | Sum(Int) |
| -| **elasticsearch.node.shards.size** | The size of the shards assigned to this node. | By | Sum(Int) |
| -| **elasticsearch.node.thread_pool.tasks.finished** | The number of tasks finished by the thread pool. | {tasks} | Sum(Int) |
  • thread_pool_name
  • task_state
| -| **elasticsearch.node.thread_pool.tasks.queued** | The number of queued tasks in the thread pool. | {tasks} | Sum(Int) |
  • thread_pool_name
| -| **elasticsearch.node.thread_pool.threads** | The number of threads in the thread pool. | {threads} | Sum(Int) |
  • thread_pool_name
  • thread_state
| -| **elasticsearch.node.translog.operations** | Number of transaction log operations. | {operations} | Sum(Int) |
| -| **elasticsearch.node.translog.size** | Size of the transaction log. | By | Sum(Int) |
| -| **elasticsearch.node.translog.uncommitted.size** | Size of uncommitted transaction log operations. | By | Sum(Int) |
| -| **elasticsearch.os.cpu.load_avg.15m** | Fifteen-minute load average on the system (field is not present if fifteen-minute load average is not available). | 1 | Gauge(Double) |
| -| **elasticsearch.os.cpu.load_avg.1m** | One-minute load average on the system (field is not present if one-minute load average is not available). | 1 | Gauge(Double) |
| -| **elasticsearch.os.cpu.load_avg.5m** | Five-minute load average on the system (field is not present if five-minute load average is not available). | 1 | Gauge(Double) |
| -| **elasticsearch.os.cpu.usage** | Recent CPU usage for the whole system, or -1 if not supported. | % | Gauge(Int) |
| -| **elasticsearch.os.memory** | Amount of physical memory. | By | Gauge(Int) |
  • memory_state
| -| **jvm.classes.loaded** | The number of loaded classes | 1 | Gauge(Int) |
| -| **jvm.gc.collections.count** | The total number of garbage collections that have occurred | 1 | Sum(Int) |
  • collector_name
| -| **jvm.gc.collections.elapsed** | The approximate accumulated collection elapsed time | ms | Sum(Int) |
  • collector_name
| -| **jvm.memory.heap.committed** | The amount of memory that is guaranteed to be available for the heap | By | Gauge(Int) |
| -| **jvm.memory.heap.max** | The maximum amount of memory can be used for the heap | By | Gauge(Int) |
| -| **jvm.memory.heap.used** | The current heap memory usage | By | Gauge(Int) |
| -| jvm.memory.heap.utilization | Fraction of heap memory usage | 1 | Gauge(Double) |
| -| **jvm.memory.nonheap.committed** | The amount of memory that is guaranteed to be available for non-heap purposes | By | Gauge(Int) |
| -| **jvm.memory.nonheap.used** | The current non-heap memory usage | By | Gauge(Int) |
| -| **jvm.memory.pool.max** | The maximum amount of memory can be used for the memory pool | By | Gauge(Int) |
  • memory_pool_name
| -| **jvm.memory.pool.used** | The current memory pool memory usage | By | Gauge(Int) |
  • memory_pool_name
| -| **jvm.threads.count** | The current number of threads | 1 | Gauge(Int) |
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: false ``` -## Resource attributes - -| Name | Description | Type | -| ---- | ----------- | ---- | -| elasticsearch.cluster.name | The name of the elasticsearch cluster. | Str | -| elasticsearch.index.name | The name of the elasticsearch index. | Str | -| elasticsearch.node.name | The name of the elasticsearch node. | Str | - -## Metric attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| cache_name | The name of cache. | fielddata, query | -| circuit_breaker_name (name) | The name of circuit breaker. | | -| cluster_published_difference_state (state) | State of the published differences | incompatible, compatible | -| cluster_state_queue_state (state) | State of the published differences | pending, committed | -| cluster_state_update_state (state) | State of cluster state update | | -| cluster_state_update_type (type) | Type of cluster state update | computation, context_construction, commit, completion, master_apply, notification | -| collector_name (name) | The name of the garbage collector. | | -| direction | The direction of network data. | received, sent | -| document_state (state) | The state of the document. | active, deleted | -| fs_direction (direction) | The direction of filesystem IO. | read, write | -| get_result (result) | Result of get operation | hit, miss | -| health_status (status) | The health status of the cluster. | green, yellow, red | -| index_aggregation_type (aggregation) | Type of shard aggregation for index statistics | primary_shards, total | -| indexing_memory_state (state) | State of the indexing memory | current, total | -| indexing_pressure_stage (stage) | Stage of the indexing pressure | coordinating, primary, replica | -| ingest_pipeline_name (name) | Name of the ingest pipeline. | | -| memory_pool_name (name) | The name of the JVM memory pool. | | -| memory_state (state) | State of the memory | free, used | -| operation (operation) | The type of operation. | index, delete, get, query, fetch, scroll, suggest, merge, refresh, flush, warmer | -| query_cache_count_type (type) | Type of query cache count | hit, miss | -| segments_memory_object_type (object) | Type of object in segment | term, doc_value, index_writer, fixed_bit_set | -| shard_state (state) | The state of the shard. | active, active_primary, relocating, initializing, unassigned, unassigned_delayed | -| task_state (state) | The state of the task. | rejected, completed | -| thread_pool_name | The name of the thread pool. | | -| thread_state (state) | The state of the thread. | active, idle | +### elasticsearch.breaker.memory.estimated + +Estimated memory used for the operation. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | The name of circuit breaker. | Any Str | + +### elasticsearch.breaker.memory.limit + +Memory limit for the circuit breaker. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | The name of circuit breaker. | Any Str | + +### elasticsearch.breaker.tripped + +Total number of times the circuit breaker has been triggered and prevented an out of memory error. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | The name of circuit breaker. | Any Str | + +### elasticsearch.cluster.data_nodes + +The number of data nodes in the cluster. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {nodes} | Sum | Int | Cumulative | false | + +### elasticsearch.cluster.health + +The health status of the cluster. + +Health status is based on the state of its primary and replica shards. Green indicates all shards are assigned. Yellow indicates that one or more replica shards are unassigned. Red indicates that one or more primary shards are unassigned, making some data unavailable. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {status} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The health status of the cluster. | Str: ``green``, ``yellow``, ``red`` | + +### elasticsearch.cluster.in_flight_fetch + +The number of unfinished fetches. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {fetches} | Sum | Int | Cumulative | false | + +### elasticsearch.cluster.nodes + +The total number of nodes in the cluster. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {nodes} | Sum | Int | Cumulative | false | + +### elasticsearch.cluster.pending_tasks + +The number of cluster-level changes that have not yet been executed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {tasks} | Sum | Int | Cumulative | false | + +### elasticsearch.cluster.published_states.differences + +Number of differences between published cluster states. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | State of the published differences | Str: ``incompatible``, ``compatible`` | + +### elasticsearch.cluster.published_states.full + +Number of published cluster states. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | false | + +### elasticsearch.cluster.shards + +The number of shards in the cluster. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {shards} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | The state of the shard. | Str: ``active``, ``active_primary``, ``relocating``, ``initializing``, ``unassigned``, ``unassigned_delayed`` | + +### elasticsearch.cluster.state_queue + +Number of cluster states in queue. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | State of the published differences | Str: ``pending``, ``committed`` | + +### elasticsearch.cluster.state_update.count + +The number of cluster state update attempts that changed the cluster state since the node started. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | State of cluster state update | Any Str | + +### elasticsearch.cluster.state_update.time + +The cumulative amount of time updating the cluster state since the node started. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | State of cluster state update | Any Str | +| type | Type of cluster state update | Str: ``computation``, ``context_construction``, ``commit``, ``completion``, ``master_apply``, ``notification`` | + +### elasticsearch.index.operations.completed + +The number of operations completed for an index. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The type of operation. | Str: ``index``, ``delete``, ``get``, ``query``, ``fetch``, ``scroll``, ``suggest``, ``merge``, ``refresh``, ``flush``, ``warmer`` | +| aggregation | Type of shard aggregation for index statistics | Str: ``primary_shards``, ``total`` | + +### elasticsearch.index.operations.time + +Time spent on operations for an index. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The type of operation. | Str: ``index``, ``delete``, ``get``, ``query``, ``fetch``, ``scroll``, ``suggest``, ``merge``, ``refresh``, ``flush``, ``warmer`` | +| aggregation | Type of shard aggregation for index statistics | Str: ``primary_shards``, ``total`` | + +### elasticsearch.index.shards.size + +The size of the shards assigned to this index. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| aggregation | Type of shard aggregation for index statistics | Str: ``primary_shards``, ``total`` | + +### elasticsearch.indexing_pressure.memory.limit + +Configured memory limit, in bytes, for the indexing requests. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### elasticsearch.indexing_pressure.memory.total.primary_rejections + +Cumulative number of indexing requests rejected in the primary stage. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +### elasticsearch.indexing_pressure.memory.total.replica_rejections + +Number of indexing requests rejected in the replica stage. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +### elasticsearch.memory.indexing_pressure + +Memory consumed, in bytes, by indexing requests in the specified stage. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| stage | Stage of the indexing pressure | Str: ``coordinating``, ``primary``, ``replica`` | + +### elasticsearch.node.cache.count + +Total count of query cache misses across all shards assigned to selected nodes. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {count} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | Type of query cache count | Str: ``hit``, ``miss`` | + +### elasticsearch.node.cache.evictions + +The number of evictions from the cache on a node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {evictions} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cache_name | The name of cache. | Str: ``fielddata``, ``query`` | + +### elasticsearch.node.cache.memory.usage + +The size in bytes of the cache on a node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cache_name | The name of cache. | Str: ``fielddata``, ``query`` | + +### elasticsearch.node.cluster.connections + +The number of open tcp connections for internal cluster communication. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +### elasticsearch.node.cluster.io + +The number of bytes sent and received on the network for internal cluster communication. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of network data. | Str: ``received``, ``sent`` | + +### elasticsearch.node.disk.io.read + +The total number of kilobytes read across all file stores for this node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| KiBy | Sum | Int | Cumulative | false | + +### elasticsearch.node.disk.io.write + +The total number of kilobytes written across all file stores for this node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| KiBy | Sum | Int | Cumulative | false | + +### elasticsearch.node.documents + +The number of documents on the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {documents} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | The state of the document. | Str: ``active``, ``deleted`` | + +### elasticsearch.node.fs.disk.available + +The amount of disk space available to the JVM across all file stores for this node. Depending on OS or process level restrictions, this might appear less than free. This is the actual amount of free disk space the Elasticsearch node can utilise. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### elasticsearch.node.fs.disk.free + +The amount of unallocated disk space across all file stores for this node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### elasticsearch.node.fs.disk.total + +The amount of disk space across all file stores for this node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### elasticsearch.node.http.connections + +The number of HTTP connections to the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +### elasticsearch.node.ingest.documents + +Total number of documents ingested during the lifetime of this node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {documents} | Sum | Int | Cumulative | true | + +### elasticsearch.node.ingest.documents.current + +Total number of documents currently being ingested. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {documents} | Sum | Int | Cumulative | false | + +### elasticsearch.node.ingest.operations.failed + +Total number of failed ingest operations during the lifetime of this node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operation} | Sum | Int | Cumulative | true | + +### elasticsearch.node.open_files + +The number of open file descriptors held by the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {files} | Sum | Int | Cumulative | false | + +### elasticsearch.node.operations.completed + +The number of operations completed by a node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The type of operation. | Str: ``index``, ``delete``, ``get``, ``query``, ``fetch``, ``scroll``, ``suggest``, ``merge``, ``refresh``, ``flush``, ``warmer`` | + +### elasticsearch.node.operations.time + +Time spent on operations by a node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The type of operation. | Str: ``index``, ``delete``, ``get``, ``query``, ``fetch``, ``scroll``, ``suggest``, ``merge``, ``refresh``, ``flush``, ``warmer`` | + +### elasticsearch.node.pipeline.ingest.documents.current + +Total number of documents currently being ingested by a pipeline. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {documents} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | Name of the ingest pipeline. | Any Str | + +### elasticsearch.node.pipeline.ingest.documents.preprocessed + +Number of documents preprocessed by the ingest pipeline. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {documents} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | Name of the ingest pipeline. | Any Str | + +### elasticsearch.node.pipeline.ingest.operations.failed + +Total number of failed operations for the ingest pipeline. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operation} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | Name of the ingest pipeline. | Any Str | + +### elasticsearch.node.script.cache_evictions + +Total number of times the script cache has evicted old data. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +### elasticsearch.node.script.compilation_limit_triggered + +Total number of times the script compilation circuit breaker has limited inline script compilations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +### elasticsearch.node.script.compilations + +Total number of inline script compilations performed by the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {compilations} | Sum | Int | Cumulative | false | + +### elasticsearch.node.shards.data_set.size + +Total data set size of all shards assigned to the node. This includes the size of shards not stored fully on the node, such as the cache for partially mounted indices. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### elasticsearch.node.shards.reserved.size + +A prediction of how much larger the shard stores on this node will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. A value of -1 indicates that this is not available. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### elasticsearch.node.shards.size + +The size of the shards assigned to this node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### elasticsearch.node.thread_pool.tasks.finished + +The number of tasks finished by the thread pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {tasks} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| thread_pool_name | The name of the thread pool. | Any Str | +| state | The state of the task. | Str: ``rejected``, ``completed`` | + +### elasticsearch.node.thread_pool.tasks.queued + +The number of queued tasks in the thread pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {tasks} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| thread_pool_name | The name of the thread pool. | Any Str | + +### elasticsearch.node.thread_pool.threads + +The number of threads in the thread pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {threads} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| thread_pool_name | The name of the thread pool. | Any Str | +| state | The state of the thread. | Str: ``active``, ``idle`` | + +### elasticsearch.node.translog.operations + +Number of transaction log operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +### elasticsearch.node.translog.size + +Size of the transaction log. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### elasticsearch.node.translog.uncommitted.size + +Size of uncommitted transaction log operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### elasticsearch.os.cpu.load_avg.15m + +Fifteen-minute load average on the system (field is not present if fifteen-minute load average is not available). + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### elasticsearch.os.cpu.load_avg.1m + +One-minute load average on the system (field is not present if one-minute load average is not available). + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### elasticsearch.os.cpu.load_avg.5m + +Five-minute load average on the system (field is not present if five-minute load average is not available). + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### elasticsearch.os.cpu.usage + +Recent CPU usage for the whole system, or -1 if not supported. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Int | + +### elasticsearch.os.memory + +Amount of physical memory. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | State of the memory | Str: ``free``, ``used`` | + +### jvm.classes.loaded + +The number of loaded classes + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +### jvm.gc.collections.count + +The total number of garbage collections that have occurred + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | The name of the garbage collector. | Any Str | + +### jvm.gc.collections.elapsed + +The approximate accumulated collection elapsed time + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | The name of the garbage collector. | Any Str | + +### jvm.memory.heap.committed + +The amount of memory that is guaranteed to be available for the heap + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### jvm.memory.heap.max + +The maximum amount of memory can be used for the heap + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### jvm.memory.heap.used + +The current heap memory usage + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### jvm.memory.nonheap.committed + +The amount of memory that is guaranteed to be available for non-heap purposes + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### jvm.memory.nonheap.used + +The current non-heap memory usage + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### jvm.memory.pool.max + +The maximum amount of memory can be used for the memory pool + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | The name of the JVM memory pool. | Any Str | + +### jvm.memory.pool.used + +The current memory pool memory usage + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | The name of the JVM memory pool. | Any Str | + +### jvm.threads.count + +The current number of threads + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: + +```yaml +metrics: + : + enabled: true +``` + +### elasticsearch.breaker.memory.estimated + +Estimated memory used for the operation. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | The name of circuit breaker. | Any Str | + +### elasticsearch.breaker.memory.limit + +Memory limit for the circuit breaker. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | The name of circuit breaker. | Any Str | + +### elasticsearch.breaker.tripped + +Total number of times the circuit breaker has been triggered and prevented an out of memory error. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | The name of circuit breaker. | Any Str | + +### elasticsearch.cluster.data_nodes + +The number of data nodes in the cluster. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {nodes} | Sum | Int | Cumulative | false | + +### elasticsearch.cluster.health + +The health status of the cluster. + +Health status is based on the state of its primary and replica shards. Green indicates all shards are assigned. Yellow indicates that one or more replica shards are unassigned. Red indicates that one or more primary shards are unassigned, making some data unavailable. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {status} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The health status of the cluster. | Str: ``green``, ``yellow``, ``red`` | + +### elasticsearch.cluster.in_flight_fetch + +The number of unfinished fetches. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {fetches} | Sum | Int | Cumulative | false | + +### elasticsearch.cluster.nodes + +The total number of nodes in the cluster. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {nodes} | Sum | Int | Cumulative | false | + +### elasticsearch.cluster.pending_tasks + +The number of cluster-level changes that have not yet been executed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {tasks} | Sum | Int | Cumulative | false | + +### elasticsearch.cluster.published_states.differences + +Number of differences between published cluster states. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | State of the published differences | Str: ``incompatible``, ``compatible`` | + +### elasticsearch.cluster.published_states.full + +Number of published cluster states. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | false | + +### elasticsearch.cluster.shards + +The number of shards in the cluster. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {shards} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | The state of the shard. | Str: ``active``, ``active_primary``, ``relocating``, ``initializing``, ``unassigned``, ``unassigned_delayed`` | + +### elasticsearch.cluster.state_queue + +Number of cluster states in queue. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | State of the published differences | Str: ``pending``, ``committed`` | + +### elasticsearch.cluster.state_update.count + +The number of cluster state update attempts that changed the cluster state since the node started. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | State of cluster state update | Any Str | + +### elasticsearch.cluster.state_update.time + +The cumulative amount of time updating the cluster state since the node started. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | State of cluster state update | Any Str | +| type | Type of cluster state update | Str: ``computation``, ``context_construction``, ``commit``, ``completion``, ``master_apply``, ``notification`` | + +### elasticsearch.index.operations.completed + +The number of operations completed for an index. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The type of operation. | Str: ``index``, ``delete``, ``get``, ``query``, ``fetch``, ``scroll``, ``suggest``, ``merge``, ``refresh``, ``flush``, ``warmer`` | +| aggregation | Type of shard aggregation for index statistics | Str: ``primary_shards``, ``total`` | + +### elasticsearch.index.operations.time + +Time spent on operations for an index. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The type of operation. | Str: ``index``, ``delete``, ``get``, ``query``, ``fetch``, ``scroll``, ``suggest``, ``merge``, ``refresh``, ``flush``, ``warmer`` | +| aggregation | Type of shard aggregation for index statistics | Str: ``primary_shards``, ``total`` | + +### elasticsearch.index.shards.size + +The size of the shards assigned to this index. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| aggregation | Type of shard aggregation for index statistics | Str: ``primary_shards``, ``total`` | + +### elasticsearch.indexing_pressure.memory.limit + +Configured memory limit, in bytes, for the indexing requests. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### elasticsearch.indexing_pressure.memory.total.primary_rejections + +Cumulative number of indexing requests rejected in the primary stage. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +### elasticsearch.indexing_pressure.memory.total.replica_rejections + +Number of indexing requests rejected in the replica stage. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +### elasticsearch.memory.indexing_pressure + +Memory consumed, in bytes, by indexing requests in the specified stage. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| stage | Stage of the indexing pressure | Str: ``coordinating``, ``primary``, ``replica`` | + +### elasticsearch.node.cache.count + +Total count of query cache misses across all shards assigned to selected nodes. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {count} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | Type of query cache count | Str: ``hit``, ``miss`` | + +### elasticsearch.node.cache.evictions + +The number of evictions from the cache on a node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {evictions} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cache_name | The name of cache. | Str: ``fielddata``, ``query`` | + +### elasticsearch.node.cache.memory.usage + +The size in bytes of the cache on a node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cache_name | The name of cache. | Str: ``fielddata``, ``query`` | + +### elasticsearch.node.cluster.connections + +The number of open tcp connections for internal cluster communication. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +### elasticsearch.node.cluster.io + +The number of bytes sent and received on the network for internal cluster communication. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of network data. | Str: ``received``, ``sent`` | + +### elasticsearch.node.disk.io.read + +The total number of kilobytes read across all file stores for this node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| KiBy | Sum | Int | Cumulative | false | + +### elasticsearch.node.disk.io.write + +The total number of kilobytes written across all file stores for this node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| KiBy | Sum | Int | Cumulative | false | + +### elasticsearch.node.documents + +The number of documents on the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {documents} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | The state of the document. | Str: ``active``, ``deleted`` | + +### elasticsearch.node.fs.disk.available + +The amount of disk space available to the JVM across all file stores for this node. Depending on OS or process level restrictions, this might appear less than free. This is the actual amount of free disk space the Elasticsearch node can utilise. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### elasticsearch.node.fs.disk.free + +The amount of unallocated disk space across all file stores for this node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### elasticsearch.node.fs.disk.total + +The amount of disk space across all file stores for this node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### elasticsearch.node.http.connections + +The number of HTTP connections to the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +### elasticsearch.node.ingest.documents + +Total number of documents ingested during the lifetime of this node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {documents} | Sum | Int | Cumulative | true | + +### elasticsearch.node.ingest.documents.current + +Total number of documents currently being ingested. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {documents} | Sum | Int | Cumulative | false | + +### elasticsearch.node.ingest.operations.failed + +Total number of failed ingest operations during the lifetime of this node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operation} | Sum | Int | Cumulative | true | + +### elasticsearch.node.open_files + +The number of open file descriptors held by the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {files} | Sum | Int | Cumulative | false | + +### elasticsearch.node.operations.completed + +The number of operations completed by a node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The type of operation. | Str: ``index``, ``delete``, ``get``, ``query``, ``fetch``, ``scroll``, ``suggest``, ``merge``, ``refresh``, ``flush``, ``warmer`` | + +### elasticsearch.node.operations.time + +Time spent on operations by a node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The type of operation. | Str: ``index``, ``delete``, ``get``, ``query``, ``fetch``, ``scroll``, ``suggest``, ``merge``, ``refresh``, ``flush``, ``warmer`` | + +### elasticsearch.node.pipeline.ingest.documents.current + +Total number of documents currently being ingested by a pipeline. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {documents} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | Name of the ingest pipeline. | Any Str | + +### elasticsearch.node.pipeline.ingest.documents.preprocessed + +Number of documents preprocessed by the ingest pipeline. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {documents} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | Name of the ingest pipeline. | Any Str | + +### elasticsearch.node.pipeline.ingest.operations.failed + +Total number of failed operations for the ingest pipeline. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operation} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | Name of the ingest pipeline. | Any Str | + +### elasticsearch.node.script.cache_evictions + +Total number of times the script cache has evicted old data. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +### elasticsearch.node.script.compilation_limit_triggered + +Total number of times the script compilation circuit breaker has limited inline script compilations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +### elasticsearch.node.script.compilations + +Total number of inline script compilations performed by the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {compilations} | Sum | Int | Cumulative | false | + +### elasticsearch.node.shards.data_set.size + +Total data set size of all shards assigned to the node. This includes the size of shards not stored fully on the node, such as the cache for partially mounted indices. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### elasticsearch.node.shards.reserved.size + +A prediction of how much larger the shard stores on this node will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities. A value of -1 indicates that this is not available. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### elasticsearch.node.shards.size + +The size of the shards assigned to this node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### elasticsearch.node.thread_pool.tasks.finished + +The number of tasks finished by the thread pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {tasks} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| thread_pool_name | The name of the thread pool. | Any Str | +| state | The state of the task. | Str: ``rejected``, ``completed`` | + +### elasticsearch.node.thread_pool.tasks.queued + +The number of queued tasks in the thread pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {tasks} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| thread_pool_name | The name of the thread pool. | Any Str | + +### elasticsearch.node.thread_pool.threads + +The number of threads in the thread pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {threads} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| thread_pool_name | The name of the thread pool. | Any Str | +| state | The state of the thread. | Str: ``active``, ``idle`` | + +### elasticsearch.node.translog.operations + +Number of transaction log operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +### elasticsearch.node.translog.size + +Size of the transaction log. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### elasticsearch.node.translog.uncommitted.size + +Size of uncommitted transaction log operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### elasticsearch.os.cpu.load_avg.15m + +Fifteen-minute load average on the system (field is not present if fifteen-minute load average is not available). + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### elasticsearch.os.cpu.load_avg.1m + +One-minute load average on the system (field is not present if one-minute load average is not available). + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### elasticsearch.os.cpu.load_avg.5m + +Five-minute load average on the system (field is not present if five-minute load average is not available). + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### elasticsearch.os.cpu.usage + +Recent CPU usage for the whole system, or -1 if not supported. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Int | + +### elasticsearch.os.memory + +Amount of physical memory. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | State of the memory | Str: ``free``, ``used`` | + +### jvm.classes.loaded + +The number of loaded classes + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +### jvm.gc.collections.count + +The total number of garbage collections that have occurred + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | The name of the garbage collector. | Any Str | + +### jvm.gc.collections.elapsed + +The approximate accumulated collection elapsed time + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | The name of the garbage collector. | Any Str | + +### jvm.memory.heap.committed + +The amount of memory that is guaranteed to be available for the heap + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### jvm.memory.heap.max + +The maximum amount of memory can be used for the heap + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### jvm.memory.heap.used + +The current heap memory usage + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### jvm.memory.nonheap.committed + +The amount of memory that is guaranteed to be available for non-heap purposes + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### jvm.memory.nonheap.used + +The current non-heap memory usage + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### jvm.memory.pool.max + +The maximum amount of memory can be used for the memory pool + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | The name of the JVM memory pool. | Any Str | + +### jvm.memory.pool.used + +The current memory pool memory usage + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | The name of the JVM memory pool. | Any Str | + +### jvm.threads.count + +The current number of threads + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +## Resource Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| elasticsearch.cluster.name | The name of the elasticsearch cluster. | Any Str | +| elasticsearch.index.name | The name of the elasticsearch index. | Any Str | +| elasticsearch.node.name | The name of the elasticsearch node. | Any Str | diff --git a/receiver/expvarreceiver/documentation.md b/receiver/expvarreceiver/documentation.md index e351c70e77ab..4a2cad2655f4 100644 --- a/receiver/expvarreceiver/documentation.md +++ b/receiver/expvarreceiver/documentation.md @@ -2,49 +2,502 @@ # expvarreceiver -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **process.runtime.memstats.buck_hash_sys** | Bytes of memory in profiling bucket hash tables. As defined by https://pkg.go.dev/runtime#MemStats | By | Sum(Int) |
| -| **process.runtime.memstats.frees** | Cumulative count of heap objects freed. As defined by https://pkg.go.dev/runtime#MemStats | {objects} | Sum(Int) |
| -| **process.runtime.memstats.gc_cpu_fraction** | The fraction of this program's available CPU time used by the GC since the program started. As defined by https://pkg.go.dev/runtime#MemStats | 1 | Gauge(Double) |
| -| **process.runtime.memstats.gc_sys** | Bytes of memory in garbage collection metadata. As defined by https://pkg.go.dev/runtime#MemStats | By | Sum(Int) |
| -| **process.runtime.memstats.heap_alloc** | Bytes of allocated heap objects. As defined by https://pkg.go.dev/runtime#MemStats | By | Sum(Int) |
| -| **process.runtime.memstats.heap_idle** | Bytes in idle (unused) spans. As defined by https://pkg.go.dev/runtime#MemStats | By | Sum(Int) |
| -| **process.runtime.memstats.heap_inuse** | Bytes in in-use spans. As defined by https://pkg.go.dev/runtime#MemStats | By | Sum(Int) |
| -| **process.runtime.memstats.heap_objects** | Number of allocated heap objects. As defined by https://pkg.go.dev/runtime#MemStats | {objects} | Sum(Int) |
| -| **process.runtime.memstats.heap_released** | Bytes of physical memory returned to the OS. As defined by https://pkg.go.dev/runtime#MemStats | By | Sum(Int) |
| -| **process.runtime.memstats.heap_sys** | Bytes of heap memory obtained by the OS. As defined by https://pkg.go.dev/runtime#MemStats | By | Sum(Int) |
| -| **process.runtime.memstats.last_pause** | The most recent stop-the-world pause time. As defined by https://pkg.go.dev/runtime#MemStats | ns | Gauge(Int) |
| -| process.runtime.memstats.lookups | Number of pointer lookups performed by the runtime. As defined by https://pkg.go.dev/runtime#MemStats | {lookups} | Sum(Int) |
| -| **process.runtime.memstats.mallocs** | Cumulative count of heap objects allocated. As defined by https://pkg.go.dev/runtime#MemStats | {objects} | Sum(Int) |
| -| **process.runtime.memstats.mcache_inuse** | Bytes of allocated mcache structures. As defined by https://pkg.go.dev/runtime#MemStats | By | Sum(Int) |
| -| **process.runtime.memstats.mcache_sys** | Bytes of memory obtained from the OS for mcache structures. As defined by https://pkg.go.dev/runtime#MemStats | By | Sum(Int) |
| -| **process.runtime.memstats.mspan_inuse** | Bytes of allocated mspan structures. As defined by https://pkg.go.dev/runtime#MemStats | By | Sum(Int) |
| -| **process.runtime.memstats.mspan_sys** | Bytes of memory obtained from the OS for mspan structures. As defined by https://pkg.go.dev/runtime#MemStats | By | Sum(Int) |
| -| **process.runtime.memstats.next_gc** | The target heap size of the next GC cycle. As defined by https://pkg.go.dev/runtime#MemStats | By | Sum(Int) |
| -| **process.runtime.memstats.num_forced_gc** | Number of GC cycles that were forced by the application calling the GC function. As defined by https://pkg.go.dev/runtime#MemStats | By | Sum(Int) |
| -| **process.runtime.memstats.num_gc** | Number of completed GC cycles. As defined by https://pkg.go.dev/runtime#MemStats | By | Sum(Int) |
| -| **process.runtime.memstats.other_sys** | Bytes of memory in miscellaneous off-heap runtime allocations. As defined by https://pkg.go.dev/runtime#MemStats | By | Sum(Int) |
| -| **process.runtime.memstats.pause_total** | The cumulative nanoseconds in GC stop-the-world pauses since the program started. As defined by https://pkg.go.dev/runtime#MemStats | By | Sum(Int) |
| -| **process.runtime.memstats.stack_inuse** | Bytes in stack spans. As defined by https://pkg.go.dev/runtime#MemStats | By | Sum(Int) |
| -| **process.runtime.memstats.stack_sys** | Bytes of stack memory obtained from the OS. As defined by https://pkg.go.dev/runtime#MemStats | By | Sum(Int) |
| -| **process.runtime.memstats.sys** | Total bytes of memory obtained from the OS. As defined by https://pkg.go.dev/runtime#MemStats | By | Sum(Int) |
| -| process.runtime.memstats.total_alloc | Cumulative bytes allocated for heap objects. As defined by https://pkg.go.dev/runtime#MemStats | By | Sum(Int) |
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: + +```yaml +metrics: + : + enabled: false +``` + +### process.runtime.memstats.buck_hash_sys + +Bytes of memory in profiling bucket hash tables. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.frees + +Cumulative count of heap objects freed. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {objects} | Sum | Int | Cumulative | true | + +### process.runtime.memstats.gc_cpu_fraction + +The fraction of this program's available CPU time used by the GC since the program started. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### process.runtime.memstats.gc_sys + +Bytes of memory in garbage collection metadata. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.heap_alloc + +Bytes of allocated heap objects. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.heap_idle + +Bytes in idle (unused) spans. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.heap_inuse + +Bytes in in-use spans. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.heap_objects + +Number of allocated heap objects. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {objects} | Sum | Int | Cumulative | false | + +### process.runtime.memstats.heap_released + +Bytes of physical memory returned to the OS. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.heap_sys + +Bytes of heap memory obtained by the OS. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.last_pause + +The most recent stop-the-world pause time. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ns | Gauge | Int | + +### process.runtime.memstats.mallocs + +Cumulative count of heap objects allocated. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {objects} | Sum | Int | Cumulative | true | + +### process.runtime.memstats.mcache_inuse + +Bytes of allocated mcache structures. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.mcache_sys + +Bytes of memory obtained from the OS for mcache structures. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.mspan_inuse + +Bytes of allocated mspan structures. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.mspan_sys + +Bytes of memory obtained from the OS for mspan structures. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.next_gc + +The target heap size of the next GC cycle. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.num_forced_gc + +Number of GC cycles that were forced by the application calling the GC function. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +### process.runtime.memstats.num_gc + +Number of completed GC cycles. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +### process.runtime.memstats.other_sys + +Bytes of memory in miscellaneous off-heap runtime allocations. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.pause_total + +The cumulative nanoseconds in GC stop-the-world pauses since the program started. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +### process.runtime.memstats.stack_inuse + +Bytes in stack spans. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.stack_sys + +Bytes of stack memory obtained from the OS. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.sys + +Total bytes of memory obtained from the OS. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Metric attributes +### process.runtime.memstats.buck_hash_sys + +Bytes of memory in profiling bucket hash tables. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.frees + +Cumulative count of heap objects freed. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {objects} | Sum | Int | Cumulative | true | + +### process.runtime.memstats.gc_cpu_fraction + +The fraction of this program's available CPU time used by the GC since the program started. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### process.runtime.memstats.gc_sys + +Bytes of memory in garbage collection metadata. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.heap_alloc + +Bytes of allocated heap objects. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.heap_idle + +Bytes in idle (unused) spans. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.heap_inuse + +Bytes in in-use spans. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.heap_objects + +Number of allocated heap objects. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {objects} | Sum | Int | Cumulative | false | + +### process.runtime.memstats.heap_released + +Bytes of physical memory returned to the OS. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.heap_sys + +Bytes of heap memory obtained by the OS. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.last_pause + +The most recent stop-the-world pause time. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ns | Gauge | Int | + +### process.runtime.memstats.mallocs + +Cumulative count of heap objects allocated. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {objects} | Sum | Int | Cumulative | true | + +### process.runtime.memstats.mcache_inuse + +Bytes of allocated mcache structures. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.mcache_sys + +Bytes of memory obtained from the OS for mcache structures. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.mspan_inuse + +Bytes of allocated mspan structures. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.mspan_sys + +Bytes of memory obtained from the OS for mspan structures. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.next_gc + +The target heap size of the next GC cycle. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.num_forced_gc + +Number of GC cycles that were forced by the application calling the GC function. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +### process.runtime.memstats.num_gc + +Number of completed GC cycles. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +### process.runtime.memstats.other_sys + +Bytes of memory in miscellaneous off-heap runtime allocations. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.pause_total + +The cumulative nanoseconds in GC stop-the-world pauses since the program started. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +### process.runtime.memstats.stack_inuse + +Bytes in stack spans. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.stack_sys + +Bytes of stack memory obtained from the OS. + +As defined by https://pkg.go.dev/runtime#MemStats + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.runtime.memstats.sys + +Total bytes of memory obtained from the OS. + +As defined by https://pkg.go.dev/runtime#MemStats -| Name | Description | Values | -| ---- | ----------- | ------ | +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | diff --git a/receiver/flinkmetricsreceiver/documentation.md b/receiver/flinkmetricsreceiver/documentation.md index 81f7c3e2b67a..2f59feabb42a 100644 --- a/receiver/flinkmetricsreceiver/documentation.md +++ b/receiver/flinkmetricsreceiver/documentation.md @@ -2,67 +2,571 @@ # flinkmetricsreceiver -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **flink.job.checkpoint.count** | The number of checkpoints completed or failed. | {checkpoints} | Sum(Int) |
  • checkpoint
| -| **flink.job.checkpoint.in_progress** | The number of checkpoints in progress. | {checkpoints} | Sum(Int) |
| -| **flink.job.last_checkpoint.size** | The total size of the last checkpoint. | By | Sum(Int) |
| -| **flink.job.last_checkpoint.time** | The end to end duration of the last checkpoint. | ms | Gauge(Int) |
| -| **flink.job.restart.count** | The total number of restarts since this job was submitted, including full restarts and fine-grained restarts. | {restarts} | Sum(Int) |
| -| **flink.jvm.class_loader.classes_loaded** | The total number of classes loaded since the start of the JVM. | {classes} | Sum(Int) |
| -| **flink.jvm.cpu.load** | The CPU usage of the JVM for a jobmanager or taskmanager. | % | Gauge(Double) |
| -| **flink.jvm.cpu.time** | The CPU time used by the JVM for a jobmanager or taskmanager. | ns | Sum(Int) |
| -| **flink.jvm.gc.collections.count** | The total number of collections that have occurred. | {collections} | Sum(Int) |
  • garbage_collector_name
| -| **flink.jvm.gc.collections.time** | The total time spent performing garbage collection. | ms | Sum(Int) |
  • garbage_collector_name
| -| **flink.jvm.memory.direct.total_capacity** | The total capacity of all buffers in the direct buffer pool. | By | Sum(Int) |
| -| **flink.jvm.memory.direct.used** | The amount of memory used by the JVM for the direct buffer pool. | By | Sum(Int) |
| -| **flink.jvm.memory.heap.committed** | The amount of heap memory guaranteed to be available to the JVM. | By | Sum(Int) |
| -| **flink.jvm.memory.heap.max** | The maximum amount of heap memory that can be used for memory management. | By | Sum(Int) |
| -| **flink.jvm.memory.heap.used** | The amount of heap memory currently used. | By | Sum(Int) |
| -| **flink.jvm.memory.mapped.total_capacity** | The number of buffers in the mapped buffer pool. | By | Sum(Int) |
| -| **flink.jvm.memory.mapped.used** | The amount of memory used by the JVM for the mapped buffer pool. | By | Sum(Int) |
| -| **flink.jvm.memory.metaspace.committed** | The amount of memory guaranteed to be available to the JVM in the Metaspace memory pool. | By | Sum(Int) |
| -| **flink.jvm.memory.metaspace.max** | The maximum amount of memory that can be used in the Metaspace memory pool. | By | Sum(Int) |
| -| **flink.jvm.memory.metaspace.used** | The amount of memory currently used in the Metaspace memory pool. | By | Sum(Int) |
| -| **flink.jvm.memory.nonheap.committed** | The amount of non-heap memory guaranteed to be available to the JVM. | By | Sum(Int) |
| -| **flink.jvm.memory.nonheap.max** | The maximum amount of non-heap memory that can be used for memory management. | By | Sum(Int) |
| -| **flink.jvm.memory.nonheap.used** | The amount of non-heap memory currently used. | By | Sum(Int) |
| -| **flink.jvm.threads.count** | The total number of live threads. | {threads} | Sum(Int) |
| -| **flink.memory.managed.total** | The total amount of managed memory. | By | Sum(Int) |
| -| **flink.memory.managed.used** | The amount of managed memory currently used. | By | Sum(Int) |
| -| **flink.operator.record.count** | The number of records an operator has. | {records} | Sum(Int) |
  • operator_name
  • record
| -| **flink.operator.watermark.output** | The last watermark this operator has emitted. | ms | Sum(Int) |
  • operator_name
| -| **flink.task.record.count** | The number of records a task has. | {records} | Sum(Int) |
  • record
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: + +```yaml +metrics: + : + enabled: false +``` + +### flink.job.checkpoint.count + +The number of checkpoints completed or failed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {checkpoints} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| checkpoint | The number of checkpoints completed or that failed. | Str: ``completed``, ``failed`` | + +### flink.job.checkpoint.in_progress + +The number of checkpoints in progress. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {checkpoints} | Sum | Int | Cumulative | false | + +### flink.job.last_checkpoint.size + +The total size of the last checkpoint. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.job.last_checkpoint.time + +The end to end duration of the last checkpoint. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +### flink.job.restart.count + +The total number of restarts since this job was submitted, including full restarts and fine-grained restarts. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {restarts} | Sum | Int | Cumulative | true | + +### flink.jvm.class_loader.classes_loaded + +The total number of classes loaded since the start of the JVM. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {classes} | Sum | Int | Cumulative | true | + +### flink.jvm.cpu.load + +The CPU usage of the JVM for a jobmanager or taskmanager. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +### flink.jvm.cpu.time + +The CPU time used by the JVM for a jobmanager or taskmanager. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ns | Sum | Int | Cumulative | true | + +### flink.jvm.gc.collections.count + +The total number of collections that have occurred. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {collections} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | The names for the parallel scavenge and garbage first garbage collectors. | Str: ``PS_MarkSweep``, ``PS_Scavenge``, ``G1_Young_Generation``, ``G1_Old_Generation`` | + +### flink.jvm.gc.collections.time + +The total time spent performing garbage collection. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | The names for the parallel scavenge and garbage first garbage collectors. | Str: ``PS_MarkSweep``, ``PS_Scavenge``, ``G1_Young_Generation``, ``G1_Old_Generation`` | + +### flink.jvm.memory.direct.total_capacity + +The total capacity of all buffers in the direct buffer pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.direct.used + +The amount of memory used by the JVM for the direct buffer pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.heap.committed + +The amount of heap memory guaranteed to be available to the JVM. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.heap.max + +The maximum amount of heap memory that can be used for memory management. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.heap.used + +The amount of heap memory currently used. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.mapped.total_capacity + +The number of buffers in the mapped buffer pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.mapped.used + +The amount of memory used by the JVM for the mapped buffer pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.metaspace.committed + +The amount of memory guaranteed to be available to the JVM in the Metaspace memory pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.metaspace.max + +The maximum amount of memory that can be used in the Metaspace memory pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.metaspace.used + +The amount of memory currently used in the Metaspace memory pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.nonheap.committed + +The amount of non-heap memory guaranteed to be available to the JVM. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.nonheap.max + +The maximum amount of non-heap memory that can be used for memory management. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.nonheap.used + +The amount of non-heap memory currently used. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.threads.count + +The total number of live threads. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {threads} | Sum | Int | Cumulative | false | + +### flink.memory.managed.total + +The total amount of managed memory. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.memory.managed.used + +The amount of managed memory currently used. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.operator.record.count + +The number of records an operator has. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {records} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | The operator name. | Any Str | +| record | The number of records received in, sent out or dropped due to arriving late. | Str: ``in``, ``out``, ``dropped`` | + +### flink.operator.watermark.output + +The last watermark this operator has emitted. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | The operator name. | Any Str | + +### flink.task.record.count + +The number of records a task has. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {records} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| record | The number of records received in, sent out or dropped due to arriving late. | Str: ``in``, ``out``, ``dropped`` | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Resource attributes +### flink.job.checkpoint.count + +The number of checkpoints completed or failed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {checkpoints} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| checkpoint | The number of checkpoints completed or that failed. | Str: ``completed``, ``failed`` | + +### flink.job.checkpoint.in_progress + +The number of checkpoints in progress. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {checkpoints} | Sum | Int | Cumulative | false | + +### flink.job.last_checkpoint.size + +The total size of the last checkpoint. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.job.last_checkpoint.time + +The end to end duration of the last checkpoint. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +### flink.job.restart.count + +The total number of restarts since this job was submitted, including full restarts and fine-grained restarts. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {restarts} | Sum | Int | Cumulative | true | + +### flink.jvm.class_loader.classes_loaded + +The total number of classes loaded since the start of the JVM. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {classes} | Sum | Int | Cumulative | true | + +### flink.jvm.cpu.load + +The CPU usage of the JVM for a jobmanager or taskmanager. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +### flink.jvm.cpu.time + +The CPU time used by the JVM for a jobmanager or taskmanager. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ns | Sum | Int | Cumulative | true | + +### flink.jvm.gc.collections.count + +The total number of collections that have occurred. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {collections} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | The names for the parallel scavenge and garbage first garbage collectors. | Str: ``PS_MarkSweep``, ``PS_Scavenge``, ``G1_Young_Generation``, ``G1_Old_Generation`` | + +### flink.jvm.gc.collections.time + +The total time spent performing garbage collection. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | The names for the parallel scavenge and garbage first garbage collectors. | Str: ``PS_MarkSweep``, ``PS_Scavenge``, ``G1_Young_Generation``, ``G1_Old_Generation`` | + +### flink.jvm.memory.direct.total_capacity + +The total capacity of all buffers in the direct buffer pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.direct.used + +The amount of memory used by the JVM for the direct buffer pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.heap.committed + +The amount of heap memory guaranteed to be available to the JVM. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.heap.max + +The maximum amount of heap memory that can be used for memory management. -| Name | Description | Type | -| ---- | ----------- | ---- | -| flink.job.name | The job name. | Str | -| flink.resource.type | The flink scope type in which a metric belongs to. | Str | -| flink.subtask.index | The subtask index. | Str | -| flink.task.name | The task name. | Str | -| flink.taskmanager.id | The taskmanager ID. | Str | -| host.name | The host name. | Str | +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.heap.used + +The amount of heap memory currently used. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.mapped.total_capacity + +The number of buffers in the mapped buffer pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.mapped.used + +The amount of memory used by the JVM for the mapped buffer pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.metaspace.committed + +The amount of memory guaranteed to be available to the JVM in the Metaspace memory pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.metaspace.max + +The maximum amount of memory that can be used in the Metaspace memory pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.metaspace.used + +The amount of memory currently used in the Metaspace memory pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.nonheap.committed + +The amount of non-heap memory guaranteed to be available to the JVM. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.nonheap.max + +The maximum amount of non-heap memory that can be used for memory management. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.memory.nonheap.used + +The amount of non-heap memory currently used. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.jvm.threads.count + +The total number of live threads. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {threads} | Sum | Int | Cumulative | false | + +### flink.memory.managed.total + +The total amount of managed memory. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.memory.managed.used + +The amount of managed memory currently used. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### flink.operator.record.count + +The number of records an operator has. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {records} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | The operator name. | Any Str | +| record | The number of records received in, sent out or dropped due to arriving late. | Str: ``in``, ``out``, ``dropped`` | + +### flink.operator.watermark.output + +The last watermark this operator has emitted. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| name | The operator name. | Any Str | + +### flink.task.record.count + +The number of records a task has. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {records} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| record | The number of records received in, sent out or dropped due to arriving late. | Str: ``in``, ``out``, ``dropped`` | -## Metric attributes +## Resource Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| checkpoint | The number of checkpoints completed or that failed. | completed, failed | -| garbage_collector_name (name) | The names for the parallel scavenge and garbage first garbage collectors. | PS_MarkSweep, PS_Scavenge, G1_Young_Generation, G1_Old_Generation | -| operator_name (name) | The operator name. | | -| record | The number of records received in, sent out or dropped due to arriving late. | in, out, dropped | +| flink.job.name | The job name. | Any Str | +| flink.resource.type | The flink scope type in which a metric belongs to. | Str: ``jobmanager``, ``taskmanager`` | +| flink.subtask.index | The subtask index. | Any Str | +| flink.task.name | The task name. | Any Str | +| flink.taskmanager.id | The taskmanager ID. | Any Str | +| host.name | The host name. | Any Str | diff --git a/receiver/hostmetricsreceiver/internal/scraper/cpuscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/cpuscraper/documentation.md index 40b95a760716..3723bf722a28 100644 --- a/receiver/hostmetricsreceiver/internal/scraper/cpuscraper/documentation.md +++ b/receiver/hostmetricsreceiver/internal/scraper/cpuscraper/documentation.md @@ -2,27 +2,52 @@ # hostmetricsreceiver/cpu -## Metrics +## Default Metrics -These are the metrics available for this scraper. +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **system.cpu.time** | Total CPU seconds broken down by different states. | s | Sum(Double) |
  • cpu
  • state
| -| system.cpu.utilization | Percentage of CPU time broken down by different states. | 1 | Gauge(Double) |
  • cpu
  • state
| +```yaml +metrics: + : + enabled: false +``` -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +### system.cpu.time + +Total CPU seconds broken down by different states. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Double | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu | CPU number starting at 0. | Any Str | +| state | Breakdown of CPU usage by type. | Str: ``idle``, ``interrupt``, ``nice``, ``softirq``, ``steal``, ``system``, ``user``, ``wait`` | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Metric attributes +### system.cpu.time + +Total CPU seconds broken down by different states. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Double | Cumulative | true | + +#### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| cpu | CPU number starting at 0. | | -| state | Breakdown of CPU usage by type. | idle, interrupt, nice, softirq, steal, system, user, wait | +| cpu | CPU number starting at 0. | Any Str | +| state | Breakdown of CPU usage by type. | Str: ``idle``, ``interrupt``, ``nice``, ``softirq``, ``steal``, ``system``, ``user``, ``wait`` | diff --git a/receiver/hostmetricsreceiver/internal/scraper/diskscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/diskscraper/documentation.md index f7d25a926724..94fc306901ad 100644 --- a/receiver/hostmetricsreceiver/internal/scraper/diskscraper/documentation.md +++ b/receiver/hostmetricsreceiver/internal/scraper/diskscraper/documentation.md @@ -2,32 +2,226 @@ # hostmetricsreceiver/disk -## Metrics +## Default Metrics -These are the metrics available for this scraper. +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **system.disk.io** | Disk bytes transferred. | By | Sum(Int) |
  • device
  • direction
| -| **system.disk.io_time** | Time disk spent activated. On Windows, this is calculated as the inverse of disk idle time. | s | Sum(Double) |
  • device
| -| **system.disk.merged** | The number of disk reads/writes merged into single physical disk access operations. | {operations} | Sum(Int) |
  • device
  • direction
| -| **system.disk.operation_time** | Time spent in disk operations. | s | Sum(Double) |
  • device
  • direction
| -| **system.disk.operations** | Disk operations count. | {operations} | Sum(Int) |
  • device
  • direction
| -| **system.disk.pending_operations** | The queue size of pending I/O operations. | {operations} | Sum(Int) |
  • device
| -| **system.disk.weighted_io_time** | Time disk spent activated multiplied by the queue length. | s | Sum(Double) |
  • device
| +```yaml +metrics: + : + enabled: false +``` + +### system.disk.io + +Disk bytes transferred. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Name of the disk. | Any Str | +| direction | Direction of flow of bytes/operations (read or write). | Str: ``read``, ``write`` | + +### system.disk.io_time + +Time disk spent activated. On Windows, this is calculated as the inverse of disk idle time. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Double | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Name of the disk. | Any Str | + +### system.disk.merged + +The number of disk reads/writes merged into single physical disk access operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Name of the disk. | Any Str | +| direction | Direction of flow of bytes/operations (read or write). | Str: ``read``, ``write`` | -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +### system.disk.operation_time + +Time spent in disk operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Double | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Name of the disk. | Any Str | +| direction | Direction of flow of bytes/operations (read or write). | Str: ``read``, ``write`` | + +### system.disk.operations + +Disk operations count. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Name of the disk. | Any Str | +| direction | Direction of flow of bytes/operations (read or write). | Str: ``read``, ``write`` | + +### system.disk.pending_operations + +The queue size of pending I/O operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Name of the disk. | Any Str | + +### system.disk.weighted_io_time + +Time disk spent activated multiplied by the queue length. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Double | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Name of the disk. | Any Str | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Metric attributes +### system.disk.io + +Disk bytes transferred. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Name of the disk. | Any Str | +| direction | Direction of flow of bytes/operations (read or write). | Str: ``read``, ``write`` | + +### system.disk.io_time + +Time disk spent activated. On Windows, this is calculated as the inverse of disk idle time. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Double | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Name of the disk. | Any Str | + +### system.disk.merged + +The number of disk reads/writes merged into single physical disk access operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Name of the disk. | Any Str | +| direction | Direction of flow of bytes/operations (read or write). | Str: ``read``, ``write`` | + +### system.disk.operation_time + +Time spent in disk operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Double | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Name of the disk. | Any Str | +| direction | Direction of flow of bytes/operations (read or write). | Str: ``read``, ``write`` | + +### system.disk.operations + +Disk operations count. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Name of the disk. | Any Str | +| direction | Direction of flow of bytes/operations (read or write). | Str: ``read``, ``write`` | + +### system.disk.pending_operations + +The queue size of pending I/O operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Name of the disk. | Any Str | + +### system.disk.weighted_io_time + +Time disk spent activated multiplied by the queue length. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Double | Cumulative | true | + +#### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| device | Name of the disk. | | -| direction | Direction of flow of bytes/operations (read or write). | read, write | +| device | Name of the disk. | Any Str | diff --git a/receiver/hostmetricsreceiver/internal/scraper/filesystemscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/filesystemscraper/documentation.md index 041a367ab32e..1987317aa4f2 100644 --- a/receiver/hostmetricsreceiver/internal/scraper/filesystemscraper/documentation.md +++ b/receiver/hostmetricsreceiver/internal/scraper/filesystemscraper/documentation.md @@ -2,31 +2,94 @@ # hostmetricsreceiver/filesystem -## Metrics +## Default Metrics -These are the metrics available for this scraper. +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **system.filesystem.inodes.usage** | FileSystem inodes used. | {inodes} | Sum(Int) |
  • device
  • mode
  • mountpoint
  • type
  • state
| -| **system.filesystem.usage** | Filesystem bytes used. | By | Sum(Int) |
  • device
  • mode
  • mountpoint
  • type
  • state
| -| system.filesystem.utilization | Fraction of filesystem bytes used. | 1 | Gauge(Double) |
  • device
  • mode
  • mountpoint
  • type
| +```yaml +metrics: + : + enabled: false +``` -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +### system.filesystem.inodes.usage + +FileSystem inodes used. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {inodes} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Identifier of the filesystem. | Any Str | +| mode | Mountpoint mode such "ro", "rw", etc. | Any Str | +| mountpoint | Mountpoint path. | Any Str | +| type | Filesystem type, such as, "ext4", "tmpfs", etc. | Any Str | +| state | Breakdown of filesystem usage by type. | Str: ``free``, ``reserved``, ``used`` | + +### system.filesystem.usage + +Filesystem bytes used. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Identifier of the filesystem. | Any Str | +| mode | Mountpoint mode such "ro", "rw", etc. | Any Str | +| mountpoint | Mountpoint path. | Any Str | +| type | Filesystem type, such as, "ext4", "tmpfs", etc. | Any Str | +| state | Breakdown of filesystem usage by type. | Str: ``free``, ``reserved``, ``used`` | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Metric attributes +### system.filesystem.inodes.usage + +FileSystem inodes used. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {inodes} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Identifier of the filesystem. | Any Str | +| mode | Mountpoint mode such "ro", "rw", etc. | Any Str | +| mountpoint | Mountpoint path. | Any Str | +| type | Filesystem type, such as, "ext4", "tmpfs", etc. | Any Str | +| state | Breakdown of filesystem usage by type. | Str: ``free``, ``reserved``, ``used`` | + +### system.filesystem.usage + +Filesystem bytes used. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| device | Identifier of the filesystem. | | -| mode | Mountpoint mode such "ro", "rw", etc. | | -| mountpoint | Mountpoint path. | | -| state | Breakdown of filesystem usage by type. | free, reserved, used | -| type | Filesystem type, such as, "ext4", "tmpfs", etc. | | +| device | Identifier of the filesystem. | Any Str | +| mode | Mountpoint mode such "ro", "rw", etc. | Any Str | +| mountpoint | Mountpoint path. | Any Str | +| type | Filesystem type, such as, "ext4", "tmpfs", etc. | Any Str | +| state | Breakdown of filesystem usage by type. | Str: ``free``, ``reserved``, ``used`` | diff --git a/receiver/hostmetricsreceiver/internal/scraper/loadscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/loadscraper/documentation.md index ab2fac72ee5f..d07752c010d9 100644 --- a/receiver/hostmetricsreceiver/internal/scraper/loadscraper/documentation.md +++ b/receiver/hostmetricsreceiver/internal/scraper/loadscraper/documentation.md @@ -2,26 +2,70 @@ # hostmetricsreceiver/load -## Metrics +## Default Metrics -These are the metrics available for this scraper. +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **system.cpu.load_average.15m** | Average CPU Load over 15 minutes. | 1 | Gauge(Double) |
| -| **system.cpu.load_average.1m** | Average CPU Load over 1 minute. | 1 | Gauge(Double) |
| -| **system.cpu.load_average.5m** | Average CPU Load over 5 minutes. | 1 | Gauge(Double) |
| +```yaml +metrics: + : + enabled: false +``` + +### system.cpu.load_average.15m + +Average CPU Load over 15 minutes. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### system.cpu.load_average.1m + +Average CPU Load over 1 minute. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### system.cpu.load_average.5m -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +Average CPU Load over 5 minutes. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Metric attributes +### system.cpu.load_average.15m + +Average CPU Load over 15 minutes. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### system.cpu.load_average.1m + +Average CPU Load over 1 minute. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### system.cpu.load_average.5m + +Average CPU Load over 5 minutes. -| Name | Description | Values | -| ---- | ----------- | ------ | +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | diff --git a/receiver/hostmetricsreceiver/internal/scraper/memoryscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/memoryscraper/documentation.md index ea7d4f534f6a..1b9b0468eb29 100644 --- a/receiver/hostmetricsreceiver/internal/scraper/memoryscraper/documentation.md +++ b/receiver/hostmetricsreceiver/internal/scraper/memoryscraper/documentation.md @@ -2,26 +2,50 @@ # hostmetricsreceiver/memory -## Metrics +## Default Metrics -These are the metrics available for this scraper. +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **system.memory.usage** | Bytes of memory in use. | By | Sum(Int) |
  • state
| -| system.memory.utilization | Percentage of memory bytes in use. | 1 | Gauge(Double) |
  • state
| +```yaml +metrics: + : + enabled: false +``` -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +### system.memory.usage + +Bytes of memory in use. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | Breakdown of memory usage by type. | Str: ``buffered``, ``cached``, ``inactive``, ``free``, ``slab_reclaimable``, ``slab_unreclaimable``, ``used`` | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Metric attributes +### system.memory.usage + +Bytes of memory in use. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| state | Breakdown of memory usage by type. | buffered, cached, inactive, free, slab_reclaimable, slab_unreclaimable, used | +| state | Breakdown of memory usage by type. | Str: ``buffered``, ``cached``, ``inactive``, ``free``, ``slab_reclaimable``, ``slab_unreclaimable``, ``used`` | diff --git a/receiver/hostmetricsreceiver/internal/scraper/networkscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/networkscraper/documentation.md index 624c6a236d01..a7bcbe41d27f 100644 --- a/receiver/hostmetricsreceiver/internal/scraper/networkscraper/documentation.md +++ b/receiver/hostmetricsreceiver/internal/scraper/networkscraper/documentation.md @@ -2,34 +2,172 @@ # hostmetricsreceiver/network -## Metrics +## Default Metrics -These are the metrics available for this scraper. +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **system.network.connections** | The number of connections. | {connections} | Sum(Int) |
  • protocol
  • state
| -| system.network.conntrack.count | The count of entries in conntrack table. | {entries} | Sum(Int) |
| -| system.network.conntrack.max | The limit for entries in the conntrack table. | {entries} | Sum(Int) |
| -| **system.network.dropped** | The number of packets dropped. | {packets} | Sum(Int) |
  • device
  • direction
| -| **system.network.errors** | The number of errors encountered. | {errors} | Sum(Int) |
  • device
  • direction
| -| **system.network.io** | The number of bytes transmitted and received. | By | Sum(Int) |
  • device
  • direction
| -| **system.network.packets** | The number of packets transferred. | {packets} | Sum(Int) |
  • device
  • direction
| +```yaml +metrics: + : + enabled: false +``` + +### system.network.connections + +The number of connections. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| protocol | Network protocol, e.g. TCP or UDP. | Str: ``tcp`` | +| state | State of the network connection. | Any Str | + +### system.network.dropped + +The number of packets dropped. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Name of the network interface. | Any Str | +| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +### system.network.errors + +The number of errors encountered. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {errors} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Name of the network interface. | Any Str | +| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | + +### system.network.io + +The number of bytes transmitted and received. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Name of the network interface. | Any Str | +| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | + +### system.network.packets + +The number of packets transferred. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Name of the network interface. | Any Str | +| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Metric attributes +### system.network.connections + +The number of connections. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| protocol | Network protocol, e.g. TCP or UDP. | Str: ``tcp`` | +| state | State of the network connection. | Any Str | + +### system.network.dropped + +The number of packets dropped. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Name of the network interface. | Any Str | +| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | + +### system.network.errors + +The number of errors encountered. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {errors} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Name of the network interface. | Any Str | +| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | + +### system.network.io + +The number of bytes transmitted and received. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Name of the network interface. | Any Str | +| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | + +### system.network.packets + +The number of packets transferred. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets} | Sum | Int | Cumulative | true | + +#### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| device | Name of the network interface. | | -| direction | Direction of flow of bytes/operations (receive or transmit). | receive, transmit | -| protocol | Network protocol, e.g. TCP or UDP. | tcp | -| state | State of the network connection. | | +| device | Name of the network interface. | Any Str | +| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | diff --git a/receiver/hostmetricsreceiver/internal/scraper/pagingscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/pagingscraper/documentation.md index 7cbcde3058e9..0af244bc8dcf 100644 --- a/receiver/hostmetricsreceiver/internal/scraper/pagingscraper/documentation.md +++ b/receiver/hostmetricsreceiver/internal/scraper/pagingscraper/documentation.md @@ -2,31 +2,110 @@ # hostmetricsreceiver/paging -## Metrics +## Default Metrics -These are the metrics available for this scraper. +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **system.paging.faults** | The number of page faults. | {faults} | Sum(Int) |
  • type
| -| **system.paging.operations** | The number of paging operations. | {operations} | Sum(Int) |
  • direction
  • type
| -| **system.paging.usage** | Swap (unix) or pagefile (windows) usage. | By | Sum(Int) |
  • device
  • state
| -| system.paging.utilization | Swap (unix) or pagefile (windows) utilization. | 1 | Gauge(Double) |
  • device
  • state
| +```yaml +metrics: + : + enabled: false +``` + +### system.paging.faults + +The number of page faults. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {faults} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | Type of fault. | Str: ``major``, ``minor`` | -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +### system.paging.operations + +The number of paging operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | Page In or Page Out. | Str: ``page_in``, ``page_out`` | +| type | Type of fault. | Str: ``major``, ``minor`` | + +### system.paging.usage + +Swap (unix) or pagefile (windows) usage. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| device | Name of the page file. | Any Str | +| state | Breakdown of paging usage by type. | Str: ``cached``, ``free``, ``used`` | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Metric attributes +### system.paging.faults + +The number of page faults. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {faults} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | Type of fault. | Str: ``major``, ``minor`` | + +### system.paging.operations + +The number of paging operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | Page In or Page Out. | Str: ``page_in``, ``page_out`` | +| type | Type of fault. | Str: ``major``, ``minor`` | + +### system.paging.usage + +Swap (unix) or pagefile (windows) usage. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| device | Name of the page file. | | -| direction | Page In or Page Out. | page_in, page_out | -| state | Breakdown of paging usage by type. | cached, free, used | -| type | Type of fault. | major, minor | +| device | Name of the page file. | Any Str | +| state | Breakdown of paging usage by type. | Str: ``cached``, ``free``, ``used`` | diff --git a/receiver/hostmetricsreceiver/internal/scraper/processesscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/processesscraper/documentation.md index b4f1900c2dca..d4b10b95568e 100644 --- a/receiver/hostmetricsreceiver/internal/scraper/processesscraper/documentation.md +++ b/receiver/hostmetricsreceiver/internal/scraper/processesscraper/documentation.md @@ -2,26 +2,66 @@ # hostmetricsreceiver/processes -## Metrics +## Default Metrics -These are the metrics available for this scraper. +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **system.processes.count** | Total number of processes in each state. | {processes} | Sum(Int) |
  • status
| -| **system.processes.created** | Total number of created processes. | {processes} | Sum(Int) |
| +```yaml +metrics: + : + enabled: false +``` + +### system.processes.count + +Total number of processes in each state. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {processes} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | Breakdown status of the processes. | Str: ``blocked``, ``daemon``, ``detached``, ``idle``, ``locked``, ``orphan``, ``paging``, ``running``, ``sleeping``, ``stopped``, ``system``, ``unknown``, ``zombies`` | -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +### system.processes.created + +Total number of created processes. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {processes} | Sum | Int | Cumulative | true | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Metric attributes +### system.processes.count + +Total number of processes in each state. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {processes} | Sum | Int | Cumulative | false | + +#### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| status | Breakdown status of the processes. | blocked, daemon, detached, idle, locked, orphan, paging, running, sleeping, stopped, system, unknown, zombies | +| status | Breakdown status of the processes. | Str: ``blocked``, ``daemon``, ``detached``, ``idle``, ``locked``, ``orphan``, ``paging``, ``running``, ``sleeping``, ``stopped``, ``system``, ``unknown``, ``zombies`` | + +### system.processes.created + +Total number of created processes. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {processes} | Sum | Int | Cumulative | true | diff --git a/receiver/hostmetricsreceiver/internal/scraper/processscraper/documentation.md b/receiver/hostmetricsreceiver/internal/scraper/processscraper/documentation.md index b61872e8e731..141f656e3a78 100644 --- a/receiver/hostmetricsreceiver/internal/scraper/processscraper/documentation.md +++ b/receiver/hostmetricsreceiver/internal/scraper/processscraper/documentation.md @@ -2,51 +2,122 @@ # hostmetricsreceiver/process -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| process.context_switches | Number of times the process has been context switched. | {count} | Sum(Int) |
  • context_switch_type
| -| **process.cpu.time** | Total CPU seconds broken down by different states. | s | Sum(Double) |
  • state
| -| process.cpu.utilization | Percentage of total CPU time used by the process since last scrape, expressed as a value between 0 and 1. On the first scrape, no data point is emitted for this metric. | 1 | Gauge(Double) |
  • state
| -| **process.disk.io** | Disk bytes transferred. | By | Sum(Int) |
  • direction
| -| **process.memory.physical_usage** | Deprecated: use `process.memory.usage` metric instead. The amount of physical memory in use. | By | Sum(Int) |
| -| process.memory.usage | The amount of physical memory in use. | By | Sum(Int) |
| -| process.memory.virtual | Virtual memory size. | By | Sum(Int) |
| -| **process.memory.virtual_usage** | Deprecated: Use `process.memory.virtual` metric instead. Virtual memory size. | By | Sum(Int) |
| -| process.open_file_descriptors | Number of file descriptors in use by the process. | {count} | Sum(Int) |
| -| process.paging.faults | Number of page faults the process has made. This metric is only available on Linux. | {faults} | Sum(Int) |
  • paging_fault_type
| -| process.signals_pending | Number of pending signals for the process. This metric is only available on Linux. | {signals} | Sum(Int) |
| -| process.threads | Process threads count. | {threads} | Sum(Int) |
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: + +```yaml +metrics: + : + enabled: false +``` + +### process.cpu.time + +Total CPU seconds broken down by different states. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Double | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | Breakdown of CPU usage by type. | Str: ``system``, ``user``, ``wait`` | + +### process.disk.io + +Disk bytes transferred. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | Direction of flow of bytes (read or write). | Str: ``read``, ``write`` | + +### process.memory.physical_usage + +Deprecated: use `process.memory.usage` metric instead. The amount of physical memory in use. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.memory.virtual_usage + +Deprecated: Use `process.memory.virtual` metric instead. Virtual memory size. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Resource attributes +### process.cpu.time + +Total CPU seconds broken down by different states. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Double | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | Breakdown of CPU usage by type. | Str: ``system``, ``user``, ``wait`` | + +### process.disk.io + +Disk bytes transferred. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | Direction of flow of bytes (read or write). | Str: ``read``, ``write`` | + +### process.memory.physical_usage + +Deprecated: use `process.memory.usage` metric instead. The amount of physical memory in use. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### process.memory.virtual_usage + +Deprecated: Use `process.memory.virtual` metric instead. Virtual memory size. -| Name | Description | Type | -| ---- | ----------- | ---- | -| process.command | The command used to launch the process (i.e. the command name). On Linux based systems, can be set to the zeroth string in proc/[pid]/cmdline. On Windows, can be set to the first parameter extracted from GetCommandLineW. | Str | -| process.command_line | The full command used to launch the process as a single string representing the full command. On Windows, can be set to the result of GetCommandLineW. Do not set this if you have to assemble it just for monitoring; use process.command_args instead. | Str | -| process.executable.name | The name of the process executable. On Linux based systems, can be set to the Name in proc/[pid]/status. On Windows, can be set to the base name of GetProcessImageFileNameW. | Str | -| process.executable.path | The full path to the process executable. On Linux based systems, can be set to the target of proc/[pid]/exe. On Windows, can be set to the result of GetProcessImageFileNameW. | Str | -| process.owner | The username of the user that owns the process. | Str | -| process.parent_pid | Parent Process identifier (PPID). | Int | -| process.pid | Process identifier (PID). | Int | +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | -## Metric attributes +## Resource Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| context_switch_type (type) | Type of context switched. | involuntary, voluntary | -| direction | Direction of flow of bytes (read or write). | read, write | -| paging_fault_type (type) | Type of memory paging fault. | major, minor | -| state | Breakdown of CPU usage by type. | system, user, wait | +| process.command | The command used to launch the process (i.e. the command name). On Linux based systems, can be set to the zeroth string in proc/[pid]/cmdline. On Windows, can be set to the first parameter extracted from GetCommandLineW. | Any Str | +| process.command_line | The full command used to launch the process as a single string representing the full command. On Windows, can be set to the result of GetCommandLineW. Do not set this if you have to assemble it just for monitoring; use process.command_args instead. | Any Str | +| process.executable.name | The name of the process executable. On Linux based systems, can be set to the Name in proc/[pid]/status. On Windows, can be set to the base name of GetProcessImageFileNameW. | Any Str | +| process.executable.path | The full path to the process executable. On Linux based systems, can be set to the target of proc/[pid]/exe. On Windows, can be set to the result of GetProcessImageFileNameW. | Any Str | +| process.owner | The username of the user that owns the process. | Any Str | +| process.parent_pid | Parent Process identifier (PPID). | Any Int | +| process.pid | Process identifier (PID). | Any Int | diff --git a/receiver/httpcheckreceiver/documentation.md b/receiver/httpcheckreceiver/documentation.md index d17d97b7645e..0fa47eb07e4e 100644 --- a/receiver/httpcheckreceiver/documentation.md +++ b/receiver/httpcheckreceiver/documentation.md @@ -2,31 +2,114 @@ # httpcheckreceiver -## Metrics +## Default Metrics -These are the metrics available for this scraper. +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **httpcheck.duration** | Measures the duration of the HTTP check. | ms | Gauge(Int) |
  • http.url
| -| **httpcheck.error** | Records errors occurring during HTTP check. | {error} | Sum(Int) |
  • http.url
  • error.message
| -| **httpcheck.status** | 1 if the check resulted in status_code matching the status_class, otherwise 0. | 1 | Sum(Int) |
  • http.url
  • http.status_code
  • http.method
  • http.status_class
| +```yaml +metrics: + : + enabled: false +``` + +### httpcheck.duration + +Measures the duration of the HTTP check. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| http.url | Full HTTP request URL. | Any Str | -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +### httpcheck.error + +Records errors occurring during HTTP check. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {error} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| http.url | Full HTTP request URL. | Any Str | +| error.message | Error message recorded during check | Any Str | + +### httpcheck.status + +1 if the check resulted in status_code matching the status_class, otherwise 0. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| http.url | Full HTTP request URL. | Any Str | +| http.status_code | HTTP response status code | Any Int | +| http.method | HTTP request method | Any Str | +| http.status_class | HTTP response status class | Any Str | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Metric attributes +### httpcheck.duration + +Measures the duration of the HTTP check. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| http.url | Full HTTP request URL. | Any Str | + +### httpcheck.error + +Records errors occurring during HTTP check. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {error} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| http.url | Full HTTP request URL. | Any Str | +| error.message | Error message recorded during check | Any Str | + +### httpcheck.status + +1 if the check resulted in status_code matching the status_class, otherwise 0. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | false | + +#### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| error.message | Error message recorded during check | | -| http.method | HTTP request method | | -| http.status_class | HTTP response status class | | -| http.status_code | HTTP response status code | | -| http.url | Full HTTP request URL. | | +| http.url | Full HTTP request URL. | Any Str | +| http.status_code | HTTP response status code | Any Int | +| http.method | HTTP request method | Any Str | +| http.status_class | HTTP response status class | Any Str | diff --git a/receiver/iisreceiver/documentation.md b/receiver/iisreceiver/documentation.md index b91eccc56aef..7fe7cf6e1e9b 100644 --- a/receiver/iisreceiver/documentation.md +++ b/receiver/iisreceiver/documentation.md @@ -2,44 +2,257 @@ # iisreceiver -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **iis.connection.active** | Number of active connections. | {connections} | Sum(Int) |
| -| **iis.connection.anonymous** | Number of connections established anonymously. | {connections} | Sum(Int) |
| -| **iis.connection.attempt.count** | Total number of attempts to connect to the server. | {attempts} | Sum(Int) |
| -| **iis.network.blocked** | Number of bytes blocked due to bandwidth throttling. | By | Sum(Int) |
| -| **iis.network.file.count** | Number of transmitted files. | {files} | Sum(Int) |
  • direction
| -| **iis.network.io** | Total amount of bytes sent and received. | By | Sum(Int) |
  • direction
| -| **iis.request.count** | Total number of requests of a given type. | {requests} | Sum(Int) |
  • request
| -| **iis.request.queue.age.max** | Age of oldest request in the queue. | ms | Gauge(Int) |
| -| **iis.request.queue.count** | Current number of requests in the queue. | {requests} | Sum(Int) |
| -| **iis.request.rejected** | Total number of requests rejected. | {requests} | Sum(Int) |
| -| **iis.thread.active** | Current number of active threads. | {threads} | Sum(Int) |
| -| **iis.uptime** | The amount of time the server has been up. | s | Gauge(Int) |
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: + +```yaml +metrics: + : + enabled: false +``` + +### iis.connection.active + +Number of active connections. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +### iis.connection.anonymous + +Number of connections established anonymously. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | true | + +### iis.connection.attempt.count + +Total number of attempts to connect to the server. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {attempts} | Sum | Int | Cumulative | true | + +### iis.network.blocked + +Number of bytes blocked due to bandwidth throttling. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +### iis.network.file.count + +Number of transmitted files. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {files} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction data is moving. | Str: ``sent``, ``received`` | + +### iis.network.io + +Total amount of bytes sent and received. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction data is moving. | Str: ``sent``, ``received`` | + +### iis.request.count + +Total number of requests of a given type. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| request | The type of request sent by a client. | Str: ``delete``, ``get``, ``head``, ``options``, ``post``, ``put``, ``trace`` | + +### iis.request.queue.age.max + +Age of oldest request in the queue. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +### iis.request.queue.count + +Current number of requests in the queue. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | false | + +### iis.request.rejected + +Total number of requests rejected. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | true | + +### iis.thread.active + +Current number of active threads. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {threads} | Sum | Int | Cumulative | false | + +### iis.uptime + +The amount of time the server has been up. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| s | Gauge | Int | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Resource attributes +### iis.connection.active + +Number of active connections. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +### iis.connection.anonymous + +Number of connections established anonymously. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | true | + +### iis.connection.attempt.count + +Total number of attempts to connect to the server. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {attempts} | Sum | Int | Cumulative | true | + +### iis.network.blocked + +Number of bytes blocked due to bandwidth throttling. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +### iis.network.file.count + +Number of transmitted files. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {files} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction data is moving. | Str: ``sent``, ``received`` | + +### iis.network.io + +Total amount of bytes sent and received. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction data is moving. | Str: ``sent``, ``received`` | + +### iis.request.count + +Total number of requests of a given type. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| request | The type of request sent by a client. | Str: ``delete``, ``get``, ``head``, ``options``, ``post``, ``put``, ``trace`` | + +### iis.request.queue.age.max + +Age of oldest request in the queue. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +### iis.request.queue.count + +Current number of requests in the queue. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | false | + +### iis.request.rejected + +Total number of requests rejected. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | true | + +### iis.thread.active + +Current number of active threads. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {threads} | Sum | Int | Cumulative | false | + +### iis.uptime + +The amount of time the server has been up. -| Name | Description | Type | -| ---- | ----------- | ---- | -| iis.application_pool | The application pool, which is associated with worker processes of one or more applications. | Str | -| iis.site | The site of the web server. | Str | +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| s | Gauge | Int | -## Metric attributes +## Resource Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| direction (direction) | The direction data is moving. | sent, received | -| request (request) | The type of request sent by a client. | delete, get, head, options, post, put, trace | +| iis.application_pool | The application pool, which is associated with worker processes of one or more applications. | Any Str | +| iis.site | The site of the web server. | Any Str | diff --git a/receiver/kafkametricsreceiver/documentation.md b/receiver/kafkametricsreceiver/documentation.md index 79a988aca87f..25f267d7cdc1 100644 --- a/receiver/kafkametricsreceiver/documentation.md +++ b/receiver/kafkametricsreceiver/documentation.md @@ -2,37 +2,338 @@ # kafkametricsreceiver -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **kafka.brokers** | Number of brokers in the cluster. | {brokers} | Gauge(Int) |
| -| **kafka.consumer_group.lag** | Current approximate lag of consumer group at partition of topic | 1 | Gauge(Int) |
  • group
  • topic
  • partition
| -| **kafka.consumer_group.lag_sum** | Current approximate sum of consumer group lag across all partitions of topic | 1 | Gauge(Int) |
  • group
  • topic
| -| **kafka.consumer_group.members** | Count of members in the consumer group | {members} | Gauge(Int) |
  • group
| -| **kafka.consumer_group.offset** | Current offset of the consumer group at partition of topic | 1 | Gauge(Int) |
  • group
  • topic
  • partition
| -| **kafka.consumer_group.offset_sum** | Sum of consumer group offset across partitions of topic | 1 | Gauge(Int) |
  • group
  • topic
| -| **kafka.partition.current_offset** | Current offset of partition of topic. | 1 | Gauge(Int) |
  • topic
  • partition
| -| **kafka.partition.oldest_offset** | Oldest offset of partition of topic | 1 | Gauge(Int) |
  • topic
  • partition
| -| **kafka.partition.replicas** | Number of replicas for partition of topic | {replicas} | Gauge(Int) |
  • topic
  • partition
| -| **kafka.partition.replicas_in_sync** | Number of synchronized replicas of partition | {replicas} | Gauge(Int) |
  • topic
  • partition
| -| **kafka.topic.partitions** | Number of partitions in topic. | {partitions} | Gauge(Int) |
  • topic
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: + +```yaml +metrics: + : + enabled: false +``` + +### kafka.brokers + +Number of brokers in the cluster. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {brokers} | Gauge | Int | + +### kafka.consumer_group.lag + +Current approximate lag of consumer group at partition of topic + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| group | The ID (string) of a consumer group | Any Str | +| topic | The ID (integer) of a topic | Any Str | +| partition | The number (integer) of the partition | Any Int | + +### kafka.consumer_group.lag_sum + +Current approximate sum of consumer group lag across all partitions of topic + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| group | The ID (string) of a consumer group | Any Str | +| topic | The ID (integer) of a topic | Any Str | + +### kafka.consumer_group.members + +Count of members in the consumer group + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {members} | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| group | The ID (string) of a consumer group | Any Str | + +### kafka.consumer_group.offset + +Current offset of the consumer group at partition of topic + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| group | The ID (string) of a consumer group | Any Str | +| topic | The ID (integer) of a topic | Any Str | +| partition | The number (integer) of the partition | Any Int | + +### kafka.consumer_group.offset_sum + +Sum of consumer group offset across partitions of topic + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| group | The ID (string) of a consumer group | Any Str | +| topic | The ID (integer) of a topic | Any Str | + +### kafka.partition.current_offset + +Current offset of partition of topic. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| topic | The ID (integer) of a topic | Any Str | +| partition | The number (integer) of the partition | Any Int | + +### kafka.partition.oldest_offset + +Oldest offset of partition of topic + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| topic | The ID (integer) of a topic | Any Str | +| partition | The number (integer) of the partition | Any Int | + +### kafka.partition.replicas + +Number of replicas for partition of topic + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {replicas} | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| topic | The ID (integer) of a topic | Any Str | +| partition | The number (integer) of the partition | Any Int | + +### kafka.partition.replicas_in_sync + +Number of synchronized replicas of partition + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {replicas} | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| topic | The ID (integer) of a topic | Any Str | +| partition | The number (integer) of the partition | Any Int | + +### kafka.topic.partitions + +Number of partitions in topic. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {partitions} | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| topic | The ID (integer) of a topic | Any Str | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Metric attributes +### kafka.brokers + +Number of brokers in the cluster. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {brokers} | Gauge | Int | + +### kafka.consumer_group.lag + +Current approximate lag of consumer group at partition of topic + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| group | The ID (string) of a consumer group | Any Str | +| topic | The ID (integer) of a topic | Any Str | +| partition | The number (integer) of the partition | Any Int | + +### kafka.consumer_group.lag_sum + +Current approximate sum of consumer group lag across all partitions of topic + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| group | The ID (string) of a consumer group | Any Str | +| topic | The ID (integer) of a topic | Any Str | + +### kafka.consumer_group.members + +Count of members in the consumer group + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {members} | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| group | The ID (string) of a consumer group | Any Str | + +### kafka.consumer_group.offset + +Current offset of the consumer group at partition of topic + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| group | The ID (string) of a consumer group | Any Str | +| topic | The ID (integer) of a topic | Any Str | +| partition | The number (integer) of the partition | Any Int | + +### kafka.consumer_group.offset_sum + +Sum of consumer group offset across partitions of topic + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| group | The ID (string) of a consumer group | Any Str | +| topic | The ID (integer) of a topic | Any Str | + +### kafka.partition.current_offset + +Current offset of partition of topic. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| topic | The ID (integer) of a topic | Any Str | +| partition | The number (integer) of the partition | Any Int | + +### kafka.partition.oldest_offset + +Oldest offset of partition of topic + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| topic | The ID (integer) of a topic | Any Str | +| partition | The number (integer) of the partition | Any Int | + +### kafka.partition.replicas + +Number of replicas for partition of topic + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {replicas} | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| topic | The ID (integer) of a topic | Any Str | +| partition | The number (integer) of the partition | Any Int | + +### kafka.partition.replicas_in_sync + +Number of synchronized replicas of partition + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {replicas} | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| topic | The ID (integer) of a topic | Any Str | +| partition | The number (integer) of the partition | Any Int | + +### kafka.topic.partitions + +Number of partitions in topic. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {partitions} | Gauge | Int | + +#### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| group | The ID (string) of a consumer group | | -| partition | The number (integer) of the partition | | -| topic | The ID (integer) of a topic | | +| topic | The ID (integer) of a topic | Any Str | diff --git a/receiver/kubeletstatsreceiver/documentation.md b/receiver/kubeletstatsreceiver/documentation.md index 845ba100967d..82f8c2372842 100644 --- a/receiver/kubeletstatsreceiver/documentation.md +++ b/receiver/kubeletstatsreceiver/documentation.md @@ -2,87 +2,770 @@ # kubeletstatsreceiver -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **container.cpu.time** | Container CPU time | s | Sum(Double) |
| -| **container.cpu.utilization** | Container CPU utilization | 1 | Gauge(Double) |
| -| **container.filesystem.available** | Container filesystem available | By | Gauge(Int) |
| -| **container.filesystem.capacity** | Container filesystem capacity | By | Gauge(Int) |
| -| **container.filesystem.usage** | Container filesystem usage | By | Gauge(Int) |
| -| **container.memory.available** | Container memory available | By | Gauge(Int) |
| -| **container.memory.major_page_faults** | Container memory major_page_faults | 1 | Gauge(Int) |
| -| **container.memory.page_faults** | Container memory page_faults | 1 | Gauge(Int) |
| -| **container.memory.rss** | Container memory rss | By | Gauge(Int) |
| -| **container.memory.usage** | Container memory usage | By | Gauge(Int) |
| -| **container.memory.working_set** | Container memory working_set | By | Gauge(Int) |
| -| **k8s.node.cpu.time** | Node CPU time | s | Sum(Double) |
| -| **k8s.node.cpu.utilization** | Node CPU utilization | 1 | Gauge(Double) |
| -| **k8s.node.filesystem.available** | Node filesystem available | By | Gauge(Int) |
| -| **k8s.node.filesystem.capacity** | Node filesystem capacity | By | Gauge(Int) |
| -| **k8s.node.filesystem.usage** | Node filesystem usage | By | Gauge(Int) |
| -| **k8s.node.memory.available** | Node memory available | By | Gauge(Int) |
| -| **k8s.node.memory.major_page_faults** | Node memory major_page_faults | 1 | Gauge(Int) |
| -| **k8s.node.memory.page_faults** | Node memory page_faults | 1 | Gauge(Int) |
| -| **k8s.node.memory.rss** | Node memory rss | By | Gauge(Int) |
| -| **k8s.node.memory.usage** | Node memory usage | By | Gauge(Int) |
| -| **k8s.node.memory.working_set** | Node memory working_set | By | Gauge(Int) |
| -| **k8s.node.network.errors** | Node network errors | 1 | Sum(Int) |
  • interface
  • direction
| -| **k8s.node.network.io** | Node network IO | By | Sum(Int) |
  • interface
  • direction
| -| **k8s.pod.cpu.time** | Pod CPU time | s | Sum(Double) |
| -| **k8s.pod.cpu.utilization** | Pod CPU utilization | 1 | Gauge(Double) |
| -| **k8s.pod.filesystem.available** | Pod filesystem available | By | Gauge(Int) |
| -| **k8s.pod.filesystem.capacity** | Pod filesystem capacity | By | Gauge(Int) |
| -| **k8s.pod.filesystem.usage** | Pod filesystem usage | By | Gauge(Int) |
| -| **k8s.pod.memory.available** | Pod memory available | By | Gauge(Int) |
| -| **k8s.pod.memory.major_page_faults** | Pod memory major_page_faults | 1 | Gauge(Int) |
| -| **k8s.pod.memory.page_faults** | Pod memory page_faults | 1 | Gauge(Int) |
| -| **k8s.pod.memory.rss** | Pod memory rss | By | Gauge(Int) |
| -| **k8s.pod.memory.usage** | Pod memory usage | By | Gauge(Int) |
| -| **k8s.pod.memory.working_set** | Pod memory working_set | By | Gauge(Int) |
| -| **k8s.pod.network.errors** | Pod network errors | 1 | Sum(Int) |
  • interface
  • direction
| -| **k8s.pod.network.io** | Pod network IO | By | Sum(Int) |
  • interface
  • direction
| -| **k8s.volume.available** | The number of available bytes in the volume. | By | Gauge(Int) |
| -| **k8s.volume.capacity** | The total capacity in bytes of the volume. | By | Gauge(Int) |
| -| **k8s.volume.inodes** | The total inodes in the filesystem. | 1 | Gauge(Int) |
| -| **k8s.volume.inodes.free** | The free inodes in the filesystem. | 1 | Gauge(Int) |
| -| **k8s.volume.inodes.used** | The inodes used by the filesystem. This may not equal inodes - free because filesystem may share inodes with other filesystems. | 1 | Gauge(Int) |
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: + +```yaml +metrics: + : + enabled: false +``` + +### container.cpu.time + +Container CPU time + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Double | Cumulative | true | + +### container.cpu.utilization + +Container CPU utilization + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### container.filesystem.available + +Container filesystem available + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### container.filesystem.capacity + +Container filesystem capacity + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### container.filesystem.usage + +Container filesystem usage + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### container.memory.available + +Container memory available + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### container.memory.major_page_faults + +Container memory major_page_faults + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +### container.memory.page_faults + +Container memory page_faults + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +### container.memory.rss + +Container memory rss + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### container.memory.usage + +Container memory usage + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### container.memory.working_set + +Container memory working_set + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.node.cpu.time + +Node CPU time + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Double | Cumulative | true | + +### k8s.node.cpu.utilization + +Node CPU utilization + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### k8s.node.filesystem.available + +Node filesystem available + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.node.filesystem.capacity + +Node filesystem capacity + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.node.filesystem.usage + +Node filesystem usage + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.node.memory.available + +Node memory available + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.node.memory.major_page_faults + +Node memory major_page_faults + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +### k8s.node.memory.page_faults + +Node memory page_faults + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +### k8s.node.memory.rss + +Node memory rss + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.node.memory.usage + +Node memory usage + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.node.memory.working_set + +Node memory working_set + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.node.network.errors + +Node network errors + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| interface | Name of the network interface. | Any Str | +| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | + +### k8s.node.network.io + +Node network IO + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| interface | Name of the network interface. | Any Str | +| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | + +### k8s.pod.cpu.time + +Pod CPU time + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Double | Cumulative | true | + +### k8s.pod.cpu.utilization + +Pod CPU utilization + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### k8s.pod.filesystem.available + +Pod filesystem available + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.pod.filesystem.capacity + +Pod filesystem capacity + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.pod.filesystem.usage + +Pod filesystem usage + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.pod.memory.available + +Pod memory available + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.pod.memory.major_page_faults + +Pod memory major_page_faults + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +### k8s.pod.memory.page_faults + +Pod memory page_faults + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +### k8s.pod.memory.rss + +Pod memory rss + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.pod.memory.usage + +Pod memory usage + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.pod.memory.working_set + +Pod memory working_set + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.pod.network.errors + +Pod network errors + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| interface | Name of the network interface. | Any Str | +| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | + +### k8s.pod.network.io + +Pod network IO + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| interface | Name of the network interface. | Any Str | +| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | + +### k8s.volume.available + +The number of available bytes in the volume. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.volume.capacity + +The total capacity in bytes of the volume. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.volume.inodes + +The total inodes in the filesystem. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +### k8s.volume.inodes.free + +The free inodes in the filesystem. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +### k8s.volume.inodes.used + +The inodes used by the filesystem. This may not equal inodes - free because filesystem may share inodes with other filesystems. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Resource attributes - -| Name | Description | Type | -| ---- | ----------- | ---- | -| aws.volume.id | The id of the AWS Volume | Str | -| container.id | Container id used to identify container | Str | -| fs.type | The filesystem type of the Volume | Str | -| gce.pd.name | The name of the persistent disk in GCE | Str | -| glusterfs.endpoints.name | The endpoint name that details Glusterfs topology | Str | -| glusterfs.path | Glusterfs volume path | Str | -| k8s.container.name | Container name used by container runtime | Str | -| k8s.namespace.name | The name of the namespace that the pod is running in | Str | -| k8s.node.name | The name of the Node | Str | -| k8s.persistentvolumeclaim.name | The name of the Persistent Volume Claim | Str | -| k8s.pod.name | The name of the Pod | Str | -| k8s.pod.uid | The UID of the Pod | Str | -| k8s.volume.name | The name of the Volume | Str | -| k8s.volume.type | The type of the Volume | Str | -| partition | The partition in the Volume | Str | - -## Metric attributes +### container.cpu.time + +Container CPU time + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Double | Cumulative | true | + +### container.cpu.utilization + +Container CPU utilization + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### container.filesystem.available + +Container filesystem available + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### container.filesystem.capacity + +Container filesystem capacity + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### container.filesystem.usage + +Container filesystem usage + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### container.memory.available + +Container memory available + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### container.memory.major_page_faults + +Container memory major_page_faults + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +### container.memory.page_faults + +Container memory page_faults + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +### container.memory.rss + +Container memory rss + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### container.memory.usage + +Container memory usage + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### container.memory.working_set + +Container memory working_set + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.node.cpu.time + +Node CPU time + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Double | Cumulative | true | + +### k8s.node.cpu.utilization + +Node CPU utilization + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### k8s.node.filesystem.available + +Node filesystem available + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.node.filesystem.capacity + +Node filesystem capacity + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.node.filesystem.usage + +Node filesystem usage + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.node.memory.available + +Node memory available + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.node.memory.major_page_faults + +Node memory major_page_faults + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +### k8s.node.memory.page_faults + +Node memory page_faults + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +### k8s.node.memory.rss + +Node memory rss + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.node.memory.usage + +Node memory usage + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.node.memory.working_set + +Node memory working_set + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.node.network.errors + +Node network errors + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| interface | Name of the network interface. | Any Str | +| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | + +### k8s.node.network.io + +Node network IO + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| interface | Name of the network interface. | Any Str | +| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | + +### k8s.pod.cpu.time + +Pod CPU time + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Double | Cumulative | true | + +### k8s.pod.cpu.utilization + +Pod CPU utilization + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### k8s.pod.filesystem.available + +Pod filesystem available + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.pod.filesystem.capacity + +Pod filesystem capacity + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.pod.filesystem.usage + +Pod filesystem usage + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.pod.memory.available + +Pod memory available + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.pod.memory.major_page_faults + +Pod memory major_page_faults + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +### k8s.pod.memory.page_faults + +Pod memory page_faults + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +### k8s.pod.memory.rss + +Pod memory rss + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.pod.memory.usage + +Pod memory usage + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.pod.memory.working_set + +Pod memory working_set + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.pod.network.errors + +Pod network errors + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| interface | Name of the network interface. | Any Str | +| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | + +### k8s.pod.network.io + +Pod network IO + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| interface | Name of the network interface. | Any Str | +| direction | Direction of flow of bytes/operations (receive or transmit). | Str: ``receive``, ``transmit`` | + +### k8s.volume.available + +The number of available bytes in the volume. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.volume.capacity + +The total capacity in bytes of the volume. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### k8s.volume.inodes + +The total inodes in the filesystem. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +### k8s.volume.inodes.free + +The free inodes in the filesystem. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +### k8s.volume.inodes.used + +The inodes used by the filesystem. This may not equal inodes - free because filesystem may share inodes with other filesystems. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Int | + +## Resource Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| direction | Direction of flow of bytes/operations (receive or transmit). | receive, transmit | -| interface | Name of the network interface. | | +| aws.volume.id | The id of the AWS Volume | Any Str | +| container.id | Container id used to identify container | Any Str | +| fs.type | The filesystem type of the Volume | Any Str | +| gce.pd.name | The name of the persistent disk in GCE | Any Str | +| glusterfs.endpoints.name | The endpoint name that details Glusterfs topology | Any Str | +| glusterfs.path | Glusterfs volume path | Any Str | +| k8s.container.name | Container name used by container runtime | Any Str | +| k8s.namespace.name | The name of the namespace that the pod is running in | Any Str | +| k8s.node.name | The name of the Node | Any Str | +| k8s.persistentvolumeclaim.name | The name of the Persistent Volume Claim | Any Str | +| k8s.pod.name | The name of the Pod | Any Str | +| k8s.pod.uid | The UID of the Pod | Any Str | +| k8s.volume.name | The name of the Volume | Any Str | +| k8s.volume.type | The type of the Volume | Any Str | +| partition | The partition in the Volume | Any Str | diff --git a/receiver/memcachedreceiver/documentation.md b/receiver/memcachedreceiver/documentation.md index d6a59f1c6c9b..7fe7f72ff69e 100644 --- a/receiver/memcachedreceiver/documentation.md +++ b/receiver/memcachedreceiver/documentation.md @@ -2,39 +2,260 @@ # memcachedreceiver -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **memcached.bytes** | Current number of bytes used by this server to store items. | By | Gauge(Int) |
| -| **memcached.commands** | Commands executed. | {commands} | Sum(Int) |
  • command
| -| **memcached.connections.current** | The current number of open connections. | {connections} | Sum(Int) |
| -| **memcached.connections.total** | Total number of connections opened since the server started running. | {connections} | Sum(Int) |
| -| **memcached.cpu.usage** | Accumulated user and system time. | s | Sum(Double) |
  • state
| -| **memcached.current_items** | Number of items currently stored in the cache. | {items} | Sum(Int) |
| -| **memcached.evictions** | Cache item evictions. | {evictions} | Sum(Int) |
| -| **memcached.network** | Bytes transferred over the network. | by | Sum(Int) |
  • direction
| -| **memcached.operation_hit_ratio** | Hit ratio for operations, expressed as a percentage value between 0.0 and 100.0. | % | Gauge(Double) |
  • operation
| -| **memcached.operations** | Operation counts. | {operations} | Sum(Int) |
  • type
  • operation
| -| **memcached.threads** | Number of threads used by the memcached instance. | {threads} | Sum(Int) |
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: + +```yaml +metrics: + : + enabled: false +``` + +### memcached.bytes + +Current number of bytes used by this server to store items. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### memcached.commands + +Commands executed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {commands} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| command | The type of command. | Str: ``get``, ``set``, ``flush``, ``touch`` | + +### memcached.connections.current + +The current number of open connections. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +### memcached.connections.total + +Total number of connections opened since the server started running. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | true | + +### memcached.cpu.usage + +Accumulated user and system time. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Double | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | The type of CPU usage. | Str: ``system``, ``user`` | + +### memcached.current_items + +Number of items currently stored in the cache. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {items} | Sum | Int | Cumulative | false | + +### memcached.evictions + +Cache item evictions. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {evictions} | Sum | Int | Cumulative | true | + +### memcached.network + +Bytes transferred over the network. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| by | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | Direction of data flow. | Str: ``sent``, ``received`` | + +### memcached.operation_hit_ratio + +Hit ratio for operations, expressed as a percentage value between 0.0 and 100.0. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The type of operation. | Str: ``increment``, ``decrement``, ``get`` | + +### memcached.operations + +Operation counts. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | Result of cache request. | Str: ``hit``, ``miss`` | +| operation | The type of operation. | Str: ``increment``, ``decrement``, ``get`` | + +### memcached.threads + +Number of threads used by the memcached instance. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {threads} | Sum | Int | Cumulative | false | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Metric attributes +### memcached.bytes + +Current number of bytes used by this server to store items. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### memcached.commands + +Commands executed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {commands} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| command | The type of command. | Str: ``get``, ``set``, ``flush``, ``touch`` | + +### memcached.connections.current + +The current number of open connections. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +### memcached.connections.total + +Total number of connections opened since the server started running. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | true | + +### memcached.cpu.usage + +Accumulated user and system time. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Double | Cumulative | true | + +#### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| command | The type of command. | get, set, flush, touch | -| direction | Direction of data flow. | sent, received | -| operation | The type of operation. | increment, decrement, get | -| state | The type of CPU usage. | system, user | -| type | Result of cache request. | hit, miss | +| state | The type of CPU usage. | Str: ``system``, ``user`` | + +### memcached.current_items + +Number of items currently stored in the cache. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {items} | Sum | Int | Cumulative | false | + +### memcached.evictions + +Cache item evictions. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {evictions} | Sum | Int | Cumulative | true | + +### memcached.network + +Bytes transferred over the network. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| by | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | Direction of data flow. | Str: ``sent``, ``received`` | + +### memcached.operation_hit_ratio + +Hit ratio for operations, expressed as a percentage value between 0.0 and 100.0. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The type of operation. | Str: ``increment``, ``decrement``, ``get`` | + +### memcached.operations + +Operation counts. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | Result of cache request. | Str: ``hit``, ``miss`` | +| operation | The type of operation. | Str: ``increment``, ``decrement``, ``get`` | + +### memcached.threads + +Number of threads used by the memcached instance. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {threads} | Sum | Int | Cumulative | false | diff --git a/receiver/mongodbatlasreceiver/documentation.md b/receiver/mongodbatlasreceiver/documentation.md index 87e1f6732e98..0bda1d88a56e 100644 --- a/receiver/mongodbatlasreceiver/documentation.md +++ b/receiver/mongodbatlasreceiver/documentation.md @@ -2,122 +2,1930 @@ # mongoatlasreceiver -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **mongodbatlas.db.counts** | Database feature size Aggregate of MongoDB Metrics DATABASE_EXTENT_COUNT, DATABASE_VIEW_COUNT, DATABASE_COLLECTION_COUNT, DATABASE_OBJECT_COUNT, DATABASE_INDEX_COUNT | {objects} | Gauge(Double) |
  • object_type
| -| **mongodbatlas.db.size** | Database feature size Aggregate of MongoDB Metrics DATABASE_DATA_SIZE, DATABASE_STORAGE_SIZE, DATABASE_INDEX_SIZE, DATABASE_AVERAGE_OBJECT_SIZE | By | Gauge(Double) |
  • object_type
| -| **mongodbatlas.disk.partition.iops.average** | Disk partition iops Aggregate of MongoDB Metrics DISK_PARTITION_IOPS_READ, DISK_PARTITION_IOPS_WRITE, DISK_PARTITION_IOPS_TOTAL | {ops}/s | Gauge(Double) |
  • disk_direction
| -| **mongodbatlas.disk.partition.iops.max** | Disk partition iops Aggregate of MongoDB Metrics MAX_DISK_PARTITION_IOPS_WRITE, MAX_DISK_PARTITION_IOPS_TOTAL, MAX_DISK_PARTITION_IOPS_READ | {ops}/s | Gauge(Double) |
  • disk_direction
| -| **mongodbatlas.disk.partition.latency.average** | Disk partition latency Aggregate of MongoDB Metrics DISK_PARTITION_LATENCY_WRITE, DISK_PARTITION_LATENCY_READ | ms | Gauge(Double) |
  • disk_direction
| -| **mongodbatlas.disk.partition.latency.max** | Disk partition latency Aggregate of MongoDB Metrics MAX_DISK_PARTITION_LATENCY_WRITE, MAX_DISK_PARTITION_LATENCY_READ | ms | Gauge(Double) |
  • disk_direction
| -| **mongodbatlas.disk.partition.space.average** | Disk partition space Aggregate of MongoDB Metrics DISK_PARTITION_SPACE_FREE, DISK_PARTITION_SPACE_USED | By | Gauge(Double) |
  • disk_status
| -| **mongodbatlas.disk.partition.space.max** | Disk partition space Aggregate of MongoDB Metrics DISK_PARTITION_SPACE_FREE, DISK_PARTITION_SPACE_USED | By | Gauge(Double) |
  • disk_status
| -| **mongodbatlas.disk.partition.usage.average** | Disk partition usage (%) Aggregate of MongoDB Metrics DISK_PARTITION_SPACE_PERCENT_FREE, DISK_PARTITION_SPACE_PERCENT_USED | 1 | Gauge(Double) |
  • disk_status
| -| **mongodbatlas.disk.partition.usage.max** | Disk partition usage (%) Aggregate of MongoDB Metrics MAX_DISK_PARTITION_SPACE_PERCENT_USED, MAX_DISK_PARTITION_SPACE_PERCENT_FREE | 1 | Gauge(Double) |
  • disk_status
| -| **mongodbatlas.disk.partition.utilization.average** | Disk partition utilization (%) MongoDB Metrics DISK_PARTITION_UTILIZATION | 1 | Gauge(Double) |
  • disk_status
| -| **mongodbatlas.disk.partition.utilization.max** | Disk partition utilization (%) MongoDB Metrics MAX_DISK_PARTITION_UTILIZATION | 1 | Gauge(Double) |
  • disk_status
| -| **mongodbatlas.process.asserts** | Number of assertions per second Aggregate of MongoDB Metrics ASSERT_REGULAR, ASSERT_USER, ASSERT_MSG, ASSERT_WARNING | {assertions}/s | Gauge(Double) |
  • assert_type
| -| **mongodbatlas.process.background_flush** | Amount of data flushed in the background MongoDB Metric BACKGROUND_FLUSH_AVG | 1 | Gauge(Double) |
| -| **mongodbatlas.process.cache.io** | Cache throughput (per second) Aggregate of MongoDB Metrics CACHE_BYTES_READ_INTO, CACHE_BYTES_WRITTEN_FROM | By | Gauge(Double) |
  • cache_direction
| -| **mongodbatlas.process.cache.size** | Cache sizes Aggregate of MongoDB Metrics CACHE_USED_BYTES, CACHE_DIRTY_BYTES | By | Sum(Double) |
  • cache_status
| -| **mongodbatlas.process.connections** | Number of current connections MongoDB Metric CONNECTIONS | {connections} | Sum(Double) |
| -| **mongodbatlas.process.cpu.children.normalized.usage.average** | CPU Usage for child processes, normalized to pct Aggregate of MongoDB Metrics PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL, PROCESS_NORMALIZED_CPU_CHILDREN_USER | 1 | Gauge(Double) |
  • cpu_state
| -| **mongodbatlas.process.cpu.children.normalized.usage.max** | CPU Usage for child processes, normalized to pct Aggregate of MongoDB Metrics MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL, MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER | 1 | Gauge(Double) |
  • cpu_state
| -| **mongodbatlas.process.cpu.children.usage.average** | CPU Usage for child processes (%) Aggregate of MongoDB Metrics PROCESS_CPU_CHILDREN_KERNEL, PROCESS_CPU_CHILDREN_USER | 1 | Gauge(Double) |
  • cpu_state
| -| **mongodbatlas.process.cpu.children.usage.max** | CPU Usage for child processes (%) Aggregate of MongoDB Metrics MAX_PROCESS_CPU_CHILDREN_USER, MAX_PROCESS_CPU_CHILDREN_KERNEL | 1 | Gauge(Double) |
  • cpu_state
| -| **mongodbatlas.process.cpu.normalized.usage.average** | CPU Usage, normalized to pct Aggregate of MongoDB Metrics PROCESS_NORMALIZED_CPU_KERNEL, PROCESS_NORMALIZED_CPU_USER | 1 | Gauge(Double) |
  • cpu_state
| -| **mongodbatlas.process.cpu.normalized.usage.max** | CPU Usage, normalized to pct Aggregate of MongoDB Metrics MAX_PROCESS_NORMALIZED_CPU_USER, MAX_PROCESS_NORMALIZED_CPU_KERNEL | 1 | Gauge(Double) |
  • cpu_state
| -| **mongodbatlas.process.cpu.usage.average** | CPU Usage (%) Aggregate of MongoDB Metrics PROCESS_CPU_KERNEL, PROCESS_CPU_USER | 1 | Gauge(Double) |
  • cpu_state
| -| **mongodbatlas.process.cpu.usage.max** | CPU Usage (%) Aggregate of MongoDB Metrics MAX_PROCESS_CPU_KERNEL, MAX_PROCESS_CPU_USER | 1 | Gauge(Double) |
  • cpu_state
| -| **mongodbatlas.process.cursors** | Number of cursors Aggregate of MongoDB Metrics CURSORS_TOTAL_OPEN, CURSORS_TOTAL_TIMED_OUT | {cursors} | Gauge(Double) |
  • cursor_state
| -| **mongodbatlas.process.db.document.rate** | Document access rates Aggregate of MongoDB Metrics DOCUMENT_METRICS_UPDATED, DOCUMENT_METRICS_DELETED, DOCUMENT_METRICS_RETURNED, DOCUMENT_METRICS_INSERTED | {documents}/s | Gauge(Double) |
  • document_status
| -| **mongodbatlas.process.db.operations.rate** | DB Operation Rates Aggregate of MongoDB Metrics OPCOUNTER_GETMORE, OPERATIONS_SCAN_AND_ORDER, OPCOUNTER_UPDATE, OPCOUNTER_REPL_UPDATE, OPCOUNTER_CMD, OPCOUNTER_DELETE, OPCOUNTER_REPL_DELETE, OPCOUNTER_REPL_CMD, OPCOUNTER_QUERY, OPCOUNTER_REPL_INSERT, OPCOUNTER_INSERT | {operations}/s | Gauge(Double) |
  • operation
  • cluster_role
| -| **mongodbatlas.process.db.operations.time** | DB Operation Times Aggregate of MongoDB Metrics OP_EXECUTION_TIME_WRITES, OP_EXECUTION_TIME_COMMANDS, OP_EXECUTION_TIME_READS | ms | Sum(Double) |
  • execution_type
| -| **mongodbatlas.process.db.query_executor.scanned** | Scanned objects Aggregate of MongoDB Metrics QUERY_EXECUTOR_SCANNED_OBJECTS, QUERY_EXECUTOR_SCANNED | {objects}/s | Gauge(Double) |
  • scanned_type
| -| **mongodbatlas.process.db.query_targeting.scanned_per_returned** | Scanned objects per returned Aggregate of MongoDB Metrics QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED, QUERY_TARGETING_SCANNED_PER_RETURNED | {scanned}/{returned} | Gauge(Double) |
  • scanned_type
| -| **mongodbatlas.process.db.storage** | Storage used by the database Aggregate of MongoDB Metrics DB_INDEX_SIZE_TOTAL, DB_DATA_SIZE_TOTAL_WO_SYSTEM, DB_STORAGE_TOTAL, DB_DATA_SIZE_TOTAL | By | Gauge(Double) |
  • storage_status
| -| **mongodbatlas.process.fts.cpu.usage** | Full text search CPU (%) Aggregate of MongoDB Metrics FTS_PROCESS_CPU_USER, FTS_PROCESS_CPU_KERNEL | 1 | Gauge(Double) |
  • cpu_state
| -| **mongodbatlas.process.global_lock** | Number and status of locks Aggregate of MongoDB Metrics GLOBAL_LOCK_CURRENT_QUEUE_WRITERS, GLOBAL_LOCK_CURRENT_QUEUE_READERS, GLOBAL_LOCK_CURRENT_QUEUE_TOTAL | {locks} | Gauge(Double) |
  • global_lock_state
| -| **mongodbatlas.process.index.btree_miss_ratio** | Index miss ratio (%) MongoDB Metric INDEX_COUNTERS_BTREE_MISS_RATIO | 1 | Gauge(Double) |
| -| **mongodbatlas.process.index.counters** | Indexes Aggregate of MongoDB Metrics INDEX_COUNTERS_BTREE_MISSES, INDEX_COUNTERS_BTREE_ACCESSES, INDEX_COUNTERS_BTREE_HITS | {indexes} | Gauge(Double) |
  • btree_counter_type
| -| **mongodbatlas.process.journaling.commits** | Journaling commits MongoDB Metric JOURNALING_COMMITS_IN_WRITE_LOCK | {commits} | Gauge(Double) |
| -| **mongodbatlas.process.journaling.data_files** | Data file sizes MongoDB Metric JOURNALING_WRITE_DATA_FILES_MB | MiBy | Gauge(Double) |
| -| **mongodbatlas.process.journaling.written** | Journals written MongoDB Metric JOURNALING_MB | MiBy | Gauge(Double) |
| -| **mongodbatlas.process.memory.usage** | Memory Usage Aggregate of MongoDB Metrics MEMORY_MAPPED, MEMORY_VIRTUAL, COMPUTED_MEMORY, MEMORY_RESIDENT | By | Gauge(Double) |
  • memory_state
| -| **mongodbatlas.process.network.io** | Network IO Aggregate of MongoDB Metrics NETWORK_BYTES_OUT, NETWORK_BYTES_IN | By/s | Gauge(Double) |
  • direction
| -| **mongodbatlas.process.network.requests** | Network requests MongoDB Metric NETWORK_NUM_REQUESTS | {requests} | Sum(Double) |
| -| **mongodbatlas.process.oplog.rate** | Execution rate by operation MongoDB Metric OPLOG_RATE_GB_PER_HOUR | GiBy/h | Gauge(Double) |
| -| **mongodbatlas.process.oplog.time** | Execution time by operation Aggregate of MongoDB Metrics OPLOG_MASTER_TIME, OPLOG_SLAVE_LAG_MASTER_TIME, OPLOG_MASTER_LAG_TIME_DIFF | s | Gauge(Double) |
  • oplog_type
| -| **mongodbatlas.process.page_faults** | Page faults Aggregate of MongoDB Metrics GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN, EXTRA_INFO_PAGE_FAULTS, GLOBAL_ACCESSES_NOT_IN_MEMORY | {faults}/s | Gauge(Double) |
  • memory_issue_type
| -| **mongodbatlas.process.restarts** | Restarts in last hour Aggregate of MongoDB Metrics RESTARTS_IN_LAST_HOUR | {restarts}/h | Gauge(Double) |
| -| **mongodbatlas.process.tickets** | Tickets Aggregate of MongoDB Metrics TICKETS_AVAILABLE_WRITE, TICKETS_AVAILABLE_READS | {tickets} | Gauge(Double) |
  • ticket_type
| -| **mongodbatlas.system.cpu.normalized.usage.average** | System CPU Normalized to pct Aggregate of MongoDB Metrics SYSTEM_NORMALIZED_CPU_IOWAIT, SYSTEM_NORMALIZED_CPU_GUEST, SYSTEM_NORMALIZED_CPU_IRQ, SYSTEM_NORMALIZED_CPU_KERNEL, SYSTEM_NORMALIZED_CPU_STEAL, SYSTEM_NORMALIZED_CPU_SOFTIRQ, SYSTEM_NORMALIZED_CPU_NICE, SYSTEM_NORMALIZED_CPU_USER | 1 | Gauge(Double) |
  • cpu_state
| -| **mongodbatlas.system.cpu.normalized.usage.max** | System CPU Normalized to pct Aggregate of MongoDB Metrics MAX_SYSTEM_NORMALIZED_CPU_USER, MAX_SYSTEM_NORMALIZED_CPU_NICE, MAX_SYSTEM_NORMALIZED_CPU_IOWAIT, MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ, MAX_SYSTEM_NORMALIZED_CPU_STEAL, MAX_SYSTEM_NORMALIZED_CPU_KERNEL, MAX_SYSTEM_NORMALIZED_CPU_GUEST, MAX_SYSTEM_NORMALIZED_CPU_IRQ | 1 | Gauge(Double) |
  • cpu_state
| -| **mongodbatlas.system.cpu.usage.average** | System CPU Usage (%) Aggregate of MongoDB Metrics SYSTEM_CPU_USER, SYSTEM_CPU_GUEST, SYSTEM_CPU_SOFTIRQ, SYSTEM_CPU_IRQ, SYSTEM_CPU_KERNEL, SYSTEM_CPU_IOWAIT, SYSTEM_CPU_NICE, SYSTEM_CPU_STEAL | 1 | Gauge(Double) |
  • cpu_state
| -| **mongodbatlas.system.cpu.usage.max** | System CPU Usage (%) Aggregate of MongoDB Metrics MAX_SYSTEM_CPU_SOFTIRQ, MAX_SYSTEM_CPU_IRQ, MAX_SYSTEM_CPU_GUEST, MAX_SYSTEM_CPU_IOWAIT, MAX_SYSTEM_CPU_NICE, MAX_SYSTEM_CPU_KERNEL, MAX_SYSTEM_CPU_USER, MAX_SYSTEM_CPU_STEAL | 1 | Gauge(Double) |
  • cpu_state
| -| **mongodbatlas.system.fts.cpu.normalized.usage** | Full text search disk usage (%) Aggregate of MongoDB Metrics FTS_PROCESS_NORMALIZED_CPU_USER, FTS_PROCESS_NORMALIZED_CPU_KERNEL | 1 | Gauge(Double) |
  • cpu_state
| -| **mongodbatlas.system.fts.cpu.usage** | Full-text search (%) | 1 | Gauge(Double) |
  • cpu_state
| -| **mongodbatlas.system.fts.disk.used** | Full text search disk usage MongoDB Metric FTS_DISK_USAGE | By | Gauge(Double) |
| -| **mongodbatlas.system.fts.memory.usage** | Full-text search Aggregate of MongoDB Metrics FTS_MEMORY_MAPPED, FTS_PROCESS_SHARED_MEMORY, FTS_PROCESS_RESIDENT_MEMORY, FTS_PROCESS_VIRTUAL_MEMORY | MiBy | Sum(Double) |
  • memory_state
| -| **mongodbatlas.system.memory.usage.average** | System Memory Usage Aggregate of MongoDB Metrics SYSTEM_MEMORY_AVAILABLE, SYSTEM_MEMORY_BUFFERS, SYSTEM_MEMORY_USED, SYSTEM_MEMORY_CACHED, SYSTEM_MEMORY_SHARED, SYSTEM_MEMORY_FREE | KiBy | Gauge(Double) |
  • memory_status
| -| **mongodbatlas.system.memory.usage.max** | System Memory Usage Aggregate of MongoDB Metrics MAX_SYSTEM_MEMORY_CACHED, MAX_SYSTEM_MEMORY_AVAILABLE, MAX_SYSTEM_MEMORY_USED, MAX_SYSTEM_MEMORY_BUFFERS, MAX_SYSTEM_MEMORY_FREE, MAX_SYSTEM_MEMORY_SHARED | KiBy | Gauge(Double) |
  • memory_status
| -| **mongodbatlas.system.network.io.average** | System Network IO Aggregate of MongoDB Metrics SYSTEM_NETWORK_IN, SYSTEM_NETWORK_OUT | By/s | Gauge(Double) |
  • direction
| -| **mongodbatlas.system.network.io.max** | System Network IO Aggregate of MongoDB Metrics MAX_SYSTEM_NETWORK_OUT, MAX_SYSTEM_NETWORK_IN | By/s | Gauge(Double) |
  • direction
| -| **mongodbatlas.system.paging.io.average** | Swap IO Aggregate of MongoDB Metrics SWAP_IO_IN, SWAP_IO_OUT | {pages}/s | Gauge(Double) |
  • direction
| -| **mongodbatlas.system.paging.io.max** | Swap IO Aggregate of MongoDB Metrics MAX_SWAP_IO_IN, MAX_SWAP_IO_OUT | {pages}/s | Gauge(Double) |
  • direction
| -| **mongodbatlas.system.paging.usage.average** | Swap usage Aggregate of MongoDB Metrics SWAP_USAGE_FREE, SWAP_USAGE_USED | KiBy | Gauge(Double) |
  • memory_state
| -| **mongodbatlas.system.paging.usage.max** | Swap usage Aggregate of MongoDB Metrics MAX_SWAP_USAGE_FREE, MAX_SWAP_USAGE_USED | KiBy | Gauge(Double) |
  • memory_state
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: false ``` -## Resource attributes - -| Name | Description | Type | -| ---- | ----------- | ---- | -| mongodb_atlas.db.name | Name of the Database | Str | -| mongodb_atlas.disk.partition | Name of a disk partition | Str | -| mongodb_atlas.host.name | Hostname of the process | Str | -| mongodb_atlas.org_name | Organization Name | Str | -| mongodb_atlas.process.id | ID of the process | Str | -| mongodb_atlas.process.port | Port process is bound to | Str | -| mongodb_atlas.process.type_name | Process type | Str | -| mongodb_atlas.project.id | Project ID | Str | -| mongodb_atlas.project.name | Project Name | Str | - -## Metric attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| assert_type | MongoDB assertion type | regular, warning, msg, user | -| btree_counter_type | Database index effectiveness | accesses, hits, misses | -| cache_direction | Whether read into or written from | read_into, written_from | -| cache_status | Cache status | dirty, used | -| cluster_role | Whether process is acting as replica or primary | primary, replica | -| cpu_state | CPU state | kernel, user, nice, iowait, irq, softirq, guest, steal | -| cursor_state | Whether cursor is open or timed out | timed_out, open | -| direction | Network traffic direction | receive, transmit | -| disk_direction | Measurement type for disk operation | read, write, total | -| disk_status | Disk measurement type | free, used | -| document_status | Status of documents in the database | returned, inserted, updated, deleted | -| execution_type | Type of command | reads, writes, commands | -| global_lock_state | Which queue is locked | current_queue_total, current_queue_readers, current_queue_writers | -| memory_issue_type | Type of memory issue encountered | extra_info, global_accesses_not_in_memory, exceptions_thrown | -| memory_state | Memory usage type | resident, virtual, mapped, computed, shared, free, used | -| memory_status | Memory measurement type | available, buffers, cached, free, shared, used | -| object_type | MongoDB object type | collection, index, extent, object, view, storage, data | -| operation | Type of database operation | cmd, query, update, delete, getmore, insert, scan_and_order | -| oplog_type | Oplog type | slave_lag_master_time, master_time, master_lag_time_diff | -| scanned_type | Objects or indexes scanned during query | index_items, objects | -| storage_status | Views on database size | total, data_size, index_size, data_size_wo_system | -| ticket_type | Type of ticket available | available_reads, available_writes | +### mongodbatlas.db.counts + +Database feature size + +Aggregate of MongoDB Metrics DATABASE_EXTENT_COUNT, DATABASE_VIEW_COUNT, DATABASE_COLLECTION_COUNT, DATABASE_OBJECT_COUNT, DATABASE_INDEX_COUNT + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {objects} | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| object_type | MongoDB object type | Str: ``collection``, ``index``, ``extent``, ``object``, ``view``, ``storage``, ``data`` | + +### mongodbatlas.db.size + +Database feature size + +Aggregate of MongoDB Metrics DATABASE_DATA_SIZE, DATABASE_STORAGE_SIZE, DATABASE_INDEX_SIZE, DATABASE_AVERAGE_OBJECT_SIZE + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| object_type | MongoDB object type | Str: ``collection``, ``index``, ``extent``, ``object``, ``view``, ``storage``, ``data`` | + +### mongodbatlas.disk.partition.iops.average + +Disk partition iops + +Aggregate of MongoDB Metrics DISK_PARTITION_IOPS_READ, DISK_PARTITION_IOPS_WRITE, DISK_PARTITION_IOPS_TOTAL + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {ops}/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_direction | Measurement type for disk operation | Str: ``read``, ``write``, ``total`` | + +### mongodbatlas.disk.partition.iops.max + +Disk partition iops + +Aggregate of MongoDB Metrics MAX_DISK_PARTITION_IOPS_WRITE, MAX_DISK_PARTITION_IOPS_TOTAL, MAX_DISK_PARTITION_IOPS_READ + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {ops}/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_direction | Measurement type for disk operation | Str: ``read``, ``write``, ``total`` | + +### mongodbatlas.disk.partition.latency.average + +Disk partition latency + +Aggregate of MongoDB Metrics DISK_PARTITION_LATENCY_WRITE, DISK_PARTITION_LATENCY_READ + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_direction | Measurement type for disk operation | Str: ``read``, ``write``, ``total`` | + +### mongodbatlas.disk.partition.latency.max + +Disk partition latency + +Aggregate of MongoDB Metrics MAX_DISK_PARTITION_LATENCY_WRITE, MAX_DISK_PARTITION_LATENCY_READ + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_direction | Measurement type for disk operation | Str: ``read``, ``write``, ``total`` | + +### mongodbatlas.disk.partition.space.average + +Disk partition space + +Aggregate of MongoDB Metrics DISK_PARTITION_SPACE_FREE, DISK_PARTITION_SPACE_USED + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_status | Disk measurement type | Str: ``free``, ``used`` | + +### mongodbatlas.disk.partition.space.max + +Disk partition space + +Aggregate of MongoDB Metrics DISK_PARTITION_SPACE_FREE, DISK_PARTITION_SPACE_USED + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_status | Disk measurement type | Str: ``free``, ``used`` | + +### mongodbatlas.disk.partition.usage.average + +Disk partition usage (%) + +Aggregate of MongoDB Metrics DISK_PARTITION_SPACE_PERCENT_FREE, DISK_PARTITION_SPACE_PERCENT_USED + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_status | Disk measurement type | Str: ``free``, ``used`` | + +### mongodbatlas.disk.partition.usage.max + +Disk partition usage (%) + +Aggregate of MongoDB Metrics MAX_DISK_PARTITION_SPACE_PERCENT_USED, MAX_DISK_PARTITION_SPACE_PERCENT_FREE + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_status | Disk measurement type | Str: ``free``, ``used`` | + +### mongodbatlas.disk.partition.utilization.average + +Disk partition utilization (%) + +MongoDB Metrics DISK_PARTITION_UTILIZATION + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_status | Disk measurement type | Str: ``free``, ``used`` | + +### mongodbatlas.disk.partition.utilization.max + +Disk partition utilization (%) + +MongoDB Metrics MAX_DISK_PARTITION_UTILIZATION + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_status | Disk measurement type | Str: ``free``, ``used`` | + +### mongodbatlas.process.asserts + +Number of assertions per second + +Aggregate of MongoDB Metrics ASSERT_REGULAR, ASSERT_USER, ASSERT_MSG, ASSERT_WARNING + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {assertions}/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| assert_type | MongoDB assertion type | Str: ``regular``, ``warning``, ``msg``, ``user`` | + +### mongodbatlas.process.background_flush + +Amount of data flushed in the background + +MongoDB Metric BACKGROUND_FLUSH_AVG + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### mongodbatlas.process.cache.io + +Cache throughput (per second) + +Aggregate of MongoDB Metrics CACHE_BYTES_READ_INTO, CACHE_BYTES_WRITTEN_FROM + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cache_direction | Whether read into or written from | Str: ``read_into``, ``written_from`` | + +### mongodbatlas.process.cache.size + +Cache sizes + +Aggregate of MongoDB Metrics CACHE_USED_BYTES, CACHE_DIRTY_BYTES + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Double | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cache_status | Cache status | Str: ``dirty``, ``used`` | + +### mongodbatlas.process.connections + +Number of current connections + +MongoDB Metric CONNECTIONS + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Double | Cumulative | false | + +### mongodbatlas.process.cpu.children.normalized.usage.average + +CPU Usage for child processes, normalized to pct + +Aggregate of MongoDB Metrics PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL, PROCESS_NORMALIZED_CPU_CHILDREN_USER + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.process.cpu.children.normalized.usage.max + +CPU Usage for child processes, normalized to pct + +Aggregate of MongoDB Metrics MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL, MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.process.cpu.children.usage.average + +CPU Usage for child processes (%) + +Aggregate of MongoDB Metrics PROCESS_CPU_CHILDREN_KERNEL, PROCESS_CPU_CHILDREN_USER + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.process.cpu.children.usage.max + +CPU Usage for child processes (%) + +Aggregate of MongoDB Metrics MAX_PROCESS_CPU_CHILDREN_USER, MAX_PROCESS_CPU_CHILDREN_KERNEL + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.process.cpu.normalized.usage.average + +CPU Usage, normalized to pct + +Aggregate of MongoDB Metrics PROCESS_NORMALIZED_CPU_KERNEL, PROCESS_NORMALIZED_CPU_USER + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.process.cpu.normalized.usage.max + +CPU Usage, normalized to pct + +Aggregate of MongoDB Metrics MAX_PROCESS_NORMALIZED_CPU_USER, MAX_PROCESS_NORMALIZED_CPU_KERNEL + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.process.cpu.usage.average + +CPU Usage (%) + +Aggregate of MongoDB Metrics PROCESS_CPU_KERNEL, PROCESS_CPU_USER + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.process.cpu.usage.max + +CPU Usage (%) + +Aggregate of MongoDB Metrics MAX_PROCESS_CPU_KERNEL, MAX_PROCESS_CPU_USER + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.process.cursors + +Number of cursors + +Aggregate of MongoDB Metrics CURSORS_TOTAL_OPEN, CURSORS_TOTAL_TIMED_OUT + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {cursors} | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cursor_state | Whether cursor is open or timed out | Str: ``timed_out``, ``open`` | + +### mongodbatlas.process.db.document.rate + +Document access rates + +Aggregate of MongoDB Metrics DOCUMENT_METRICS_UPDATED, DOCUMENT_METRICS_DELETED, DOCUMENT_METRICS_RETURNED, DOCUMENT_METRICS_INSERTED + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {documents}/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| document_status | Status of documents in the database | Str: ``returned``, ``inserted``, ``updated``, ``deleted`` | + +### mongodbatlas.process.db.operations.rate + +DB Operation Rates + +Aggregate of MongoDB Metrics OPCOUNTER_GETMORE, OPERATIONS_SCAN_AND_ORDER, OPCOUNTER_UPDATE, OPCOUNTER_REPL_UPDATE, OPCOUNTER_CMD, OPCOUNTER_DELETE, OPCOUNTER_REPL_DELETE, OPCOUNTER_REPL_CMD, OPCOUNTER_QUERY, OPCOUNTER_REPL_INSERT, OPCOUNTER_INSERT + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {operations}/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | Type of database operation | Str: ``cmd``, ``query``, ``update``, ``delete``, ``getmore``, ``insert``, ``scan_and_order`` | +| cluster_role | Whether process is acting as replica or primary | Str: ``primary``, ``replica`` | + +### mongodbatlas.process.db.operations.time + +DB Operation Times + +Aggregate of MongoDB Metrics OP_EXECUTION_TIME_WRITES, OP_EXECUTION_TIME_COMMANDS, OP_EXECUTION_TIME_READS + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Double | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| execution_type | Type of command | Str: ``reads``, ``writes``, ``commands`` | + +### mongodbatlas.process.db.query_executor.scanned + +Scanned objects + +Aggregate of MongoDB Metrics QUERY_EXECUTOR_SCANNED_OBJECTS, QUERY_EXECUTOR_SCANNED + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {objects}/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| scanned_type | Objects or indexes scanned during query | Str: ``index_items``, ``objects`` | + +### mongodbatlas.process.db.query_targeting.scanned_per_returned + +Scanned objects per returned + +Aggregate of MongoDB Metrics QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED, QUERY_TARGETING_SCANNED_PER_RETURNED + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {scanned}/{returned} | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| scanned_type | Objects or indexes scanned during query | Str: ``index_items``, ``objects`` | + +### mongodbatlas.process.db.storage + +Storage used by the database + +Aggregate of MongoDB Metrics DB_INDEX_SIZE_TOTAL, DB_DATA_SIZE_TOTAL_WO_SYSTEM, DB_STORAGE_TOTAL, DB_DATA_SIZE_TOTAL + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| storage_status | Views on database size | Str: ``total``, ``data_size``, ``index_size``, ``data_size_wo_system`` | + +### mongodbatlas.process.fts.cpu.usage + +Full text search CPU (%) + +Aggregate of MongoDB Metrics FTS_PROCESS_CPU_USER, FTS_PROCESS_CPU_KERNEL + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.process.global_lock + +Number and status of locks + +Aggregate of MongoDB Metrics GLOBAL_LOCK_CURRENT_QUEUE_WRITERS, GLOBAL_LOCK_CURRENT_QUEUE_READERS, GLOBAL_LOCK_CURRENT_QUEUE_TOTAL + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {locks} | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| global_lock_state | Which queue is locked | Str: ``current_queue_total``, ``current_queue_readers``, ``current_queue_writers`` | + +### mongodbatlas.process.index.btree_miss_ratio + +Index miss ratio (%) + +MongoDB Metric INDEX_COUNTERS_BTREE_MISS_RATIO + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### mongodbatlas.process.index.counters + +Indexes + +Aggregate of MongoDB Metrics INDEX_COUNTERS_BTREE_MISSES, INDEX_COUNTERS_BTREE_ACCESSES, INDEX_COUNTERS_BTREE_HITS + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {indexes} | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| btree_counter_type | Database index effectiveness | Str: ``accesses``, ``hits``, ``misses`` | + +### mongodbatlas.process.journaling.commits + +Journaling commits + +MongoDB Metric JOURNALING_COMMITS_IN_WRITE_LOCK + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {commits} | Gauge | Double | + +### mongodbatlas.process.journaling.data_files + +Data file sizes + +MongoDB Metric JOURNALING_WRITE_DATA_FILES_MB + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| MiBy | Gauge | Double | + +### mongodbatlas.process.journaling.written + +Journals written + +MongoDB Metric JOURNALING_MB + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| MiBy | Gauge | Double | + +### mongodbatlas.process.memory.usage + +Memory Usage + +Aggregate of MongoDB Metrics MEMORY_MAPPED, MEMORY_VIRTUAL, COMPUTED_MEMORY, MEMORY_RESIDENT + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| memory_state | Memory usage type | Str: ``resident``, ``virtual``, ``mapped``, ``computed``, ``shared``, ``free``, ``used`` | + +### mongodbatlas.process.network.io + +Network IO + +Aggregate of MongoDB Metrics NETWORK_BYTES_OUT, NETWORK_BYTES_IN + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | Network traffic direction | Str: ``receive``, ``transmit`` | + +### mongodbatlas.process.network.requests + +Network requests + +MongoDB Metric NETWORK_NUM_REQUESTS + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Double | Cumulative | true | + +### mongodbatlas.process.oplog.rate + +Execution rate by operation + +MongoDB Metric OPLOG_RATE_GB_PER_HOUR + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| GiBy/h | Gauge | Double | + +### mongodbatlas.process.oplog.time + +Execution time by operation + +Aggregate of MongoDB Metrics OPLOG_MASTER_TIME, OPLOG_SLAVE_LAG_MASTER_TIME, OPLOG_MASTER_LAG_TIME_DIFF + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| oplog_type | Oplog type | Str: ``slave_lag_master_time``, ``master_time``, ``master_lag_time_diff`` | + +### mongodbatlas.process.page_faults + +Page faults + +Aggregate of MongoDB Metrics GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN, EXTRA_INFO_PAGE_FAULTS, GLOBAL_ACCESSES_NOT_IN_MEMORY + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {faults}/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| memory_issue_type | Type of memory issue encountered | Str: ``extra_info``, ``global_accesses_not_in_memory``, ``exceptions_thrown`` | + +### mongodbatlas.process.restarts + +Restarts in last hour + +Aggregate of MongoDB Metrics RESTARTS_IN_LAST_HOUR + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {restarts}/h | Gauge | Double | + +### mongodbatlas.process.tickets + +Tickets + +Aggregate of MongoDB Metrics TICKETS_AVAILABLE_WRITE, TICKETS_AVAILABLE_READS + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {tickets} | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| ticket_type | Type of ticket available | Str: ``available_reads``, ``available_writes`` | + +### mongodbatlas.system.cpu.normalized.usage.average + +System CPU Normalized to pct + +Aggregate of MongoDB Metrics SYSTEM_NORMALIZED_CPU_IOWAIT, SYSTEM_NORMALIZED_CPU_GUEST, SYSTEM_NORMALIZED_CPU_IRQ, SYSTEM_NORMALIZED_CPU_KERNEL, SYSTEM_NORMALIZED_CPU_STEAL, SYSTEM_NORMALIZED_CPU_SOFTIRQ, SYSTEM_NORMALIZED_CPU_NICE, SYSTEM_NORMALIZED_CPU_USER + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.system.cpu.normalized.usage.max + +System CPU Normalized to pct + +Aggregate of MongoDB Metrics MAX_SYSTEM_NORMALIZED_CPU_USER, MAX_SYSTEM_NORMALIZED_CPU_NICE, MAX_SYSTEM_NORMALIZED_CPU_IOWAIT, MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ, MAX_SYSTEM_NORMALIZED_CPU_STEAL, MAX_SYSTEM_NORMALIZED_CPU_KERNEL, MAX_SYSTEM_NORMALIZED_CPU_GUEST, MAX_SYSTEM_NORMALIZED_CPU_IRQ + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.system.cpu.usage.average + +System CPU Usage (%) + +Aggregate of MongoDB Metrics SYSTEM_CPU_USER, SYSTEM_CPU_GUEST, SYSTEM_CPU_SOFTIRQ, SYSTEM_CPU_IRQ, SYSTEM_CPU_KERNEL, SYSTEM_CPU_IOWAIT, SYSTEM_CPU_NICE, SYSTEM_CPU_STEAL + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.system.cpu.usage.max + +System CPU Usage (%) + +Aggregate of MongoDB Metrics MAX_SYSTEM_CPU_SOFTIRQ, MAX_SYSTEM_CPU_IRQ, MAX_SYSTEM_CPU_GUEST, MAX_SYSTEM_CPU_IOWAIT, MAX_SYSTEM_CPU_NICE, MAX_SYSTEM_CPU_KERNEL, MAX_SYSTEM_CPU_USER, MAX_SYSTEM_CPU_STEAL + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.system.fts.cpu.normalized.usage + +Full text search disk usage (%) + +Aggregate of MongoDB Metrics FTS_PROCESS_NORMALIZED_CPU_USER, FTS_PROCESS_NORMALIZED_CPU_KERNEL + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.system.fts.cpu.usage + +Full-text search (%) + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.system.fts.disk.used + +Full text search disk usage + +MongoDB Metric FTS_DISK_USAGE + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Double | + +### mongodbatlas.system.fts.memory.usage + +Full-text search + +Aggregate of MongoDB Metrics FTS_MEMORY_MAPPED, FTS_PROCESS_SHARED_MEMORY, FTS_PROCESS_RESIDENT_MEMORY, FTS_PROCESS_VIRTUAL_MEMORY + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| MiBy | Sum | Double | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| memory_state | Memory usage type | Str: ``resident``, ``virtual``, ``mapped``, ``computed``, ``shared``, ``free``, ``used`` | + +### mongodbatlas.system.memory.usage.average + +System Memory Usage + +Aggregate of MongoDB Metrics SYSTEM_MEMORY_AVAILABLE, SYSTEM_MEMORY_BUFFERS, SYSTEM_MEMORY_USED, SYSTEM_MEMORY_CACHED, SYSTEM_MEMORY_SHARED, SYSTEM_MEMORY_FREE + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| KiBy | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| memory_status | Memory measurement type | Str: ``available``, ``buffers``, ``cached``, ``free``, ``shared``, ``used`` | + +### mongodbatlas.system.memory.usage.max + +System Memory Usage + +Aggregate of MongoDB Metrics MAX_SYSTEM_MEMORY_CACHED, MAX_SYSTEM_MEMORY_AVAILABLE, MAX_SYSTEM_MEMORY_USED, MAX_SYSTEM_MEMORY_BUFFERS, MAX_SYSTEM_MEMORY_FREE, MAX_SYSTEM_MEMORY_SHARED + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| KiBy | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| memory_status | Memory measurement type | Str: ``available``, ``buffers``, ``cached``, ``free``, ``shared``, ``used`` | + +### mongodbatlas.system.network.io.average + +System Network IO + +Aggregate of MongoDB Metrics SYSTEM_NETWORK_IN, SYSTEM_NETWORK_OUT + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | Network traffic direction | Str: ``receive``, ``transmit`` | + +### mongodbatlas.system.network.io.max + +System Network IO + +Aggregate of MongoDB Metrics MAX_SYSTEM_NETWORK_OUT, MAX_SYSTEM_NETWORK_IN + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | Network traffic direction | Str: ``receive``, ``transmit`` | + +### mongodbatlas.system.paging.io.average + +Swap IO + +Aggregate of MongoDB Metrics SWAP_IO_IN, SWAP_IO_OUT + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {pages}/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | Network traffic direction | Str: ``receive``, ``transmit`` | + +### mongodbatlas.system.paging.io.max + +Swap IO + +Aggregate of MongoDB Metrics MAX_SWAP_IO_IN, MAX_SWAP_IO_OUT + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {pages}/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | Network traffic direction | Str: ``receive``, ``transmit`` | + +### mongodbatlas.system.paging.usage.average + +Swap usage + +Aggregate of MongoDB Metrics SWAP_USAGE_FREE, SWAP_USAGE_USED + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| KiBy | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| memory_state | Memory usage type | Str: ``resident``, ``virtual``, ``mapped``, ``computed``, ``shared``, ``free``, ``used`` | + +### mongodbatlas.system.paging.usage.max + +Swap usage + +Aggregate of MongoDB Metrics MAX_SWAP_USAGE_FREE, MAX_SWAP_USAGE_USED + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| KiBy | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| memory_state | Memory usage type | Str: ``resident``, ``virtual``, ``mapped``, ``computed``, ``shared``, ``free``, ``used`` | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: + +```yaml +metrics: + : + enabled: true +``` + +### mongodbatlas.db.counts + +Database feature size + +Aggregate of MongoDB Metrics DATABASE_EXTENT_COUNT, DATABASE_VIEW_COUNT, DATABASE_COLLECTION_COUNT, DATABASE_OBJECT_COUNT, DATABASE_INDEX_COUNT + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {objects} | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| object_type | MongoDB object type | Str: ``collection``, ``index``, ``extent``, ``object``, ``view``, ``storage``, ``data`` | + +### mongodbatlas.db.size + +Database feature size + +Aggregate of MongoDB Metrics DATABASE_DATA_SIZE, DATABASE_STORAGE_SIZE, DATABASE_INDEX_SIZE, DATABASE_AVERAGE_OBJECT_SIZE + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| object_type | MongoDB object type | Str: ``collection``, ``index``, ``extent``, ``object``, ``view``, ``storage``, ``data`` | + +### mongodbatlas.disk.partition.iops.average + +Disk partition iops + +Aggregate of MongoDB Metrics DISK_PARTITION_IOPS_READ, DISK_PARTITION_IOPS_WRITE, DISK_PARTITION_IOPS_TOTAL + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {ops}/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_direction | Measurement type for disk operation | Str: ``read``, ``write``, ``total`` | + +### mongodbatlas.disk.partition.iops.max + +Disk partition iops + +Aggregate of MongoDB Metrics MAX_DISK_PARTITION_IOPS_WRITE, MAX_DISK_PARTITION_IOPS_TOTAL, MAX_DISK_PARTITION_IOPS_READ + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {ops}/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_direction | Measurement type for disk operation | Str: ``read``, ``write``, ``total`` | + +### mongodbatlas.disk.partition.latency.average + +Disk partition latency + +Aggregate of MongoDB Metrics DISK_PARTITION_LATENCY_WRITE, DISK_PARTITION_LATENCY_READ + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_direction | Measurement type for disk operation | Str: ``read``, ``write``, ``total`` | + +### mongodbatlas.disk.partition.latency.max + +Disk partition latency + +Aggregate of MongoDB Metrics MAX_DISK_PARTITION_LATENCY_WRITE, MAX_DISK_PARTITION_LATENCY_READ + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_direction | Measurement type for disk operation | Str: ``read``, ``write``, ``total`` | + +### mongodbatlas.disk.partition.space.average + +Disk partition space + +Aggregate of MongoDB Metrics DISK_PARTITION_SPACE_FREE, DISK_PARTITION_SPACE_USED + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_status | Disk measurement type | Str: ``free``, ``used`` | + +### mongodbatlas.disk.partition.space.max + +Disk partition space + +Aggregate of MongoDB Metrics DISK_PARTITION_SPACE_FREE, DISK_PARTITION_SPACE_USED + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_status | Disk measurement type | Str: ``free``, ``used`` | + +### mongodbatlas.disk.partition.usage.average + +Disk partition usage (%) + +Aggregate of MongoDB Metrics DISK_PARTITION_SPACE_PERCENT_FREE, DISK_PARTITION_SPACE_PERCENT_USED + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_status | Disk measurement type | Str: ``free``, ``used`` | + +### mongodbatlas.disk.partition.usage.max + +Disk partition usage (%) + +Aggregate of MongoDB Metrics MAX_DISK_PARTITION_SPACE_PERCENT_USED, MAX_DISK_PARTITION_SPACE_PERCENT_FREE + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_status | Disk measurement type | Str: ``free``, ``used`` | + +### mongodbatlas.disk.partition.utilization.average + +Disk partition utilization (%) + +MongoDB Metrics DISK_PARTITION_UTILIZATION + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_status | Disk measurement type | Str: ``free``, ``used`` | + +### mongodbatlas.disk.partition.utilization.max + +Disk partition utilization (%) + +MongoDB Metrics MAX_DISK_PARTITION_UTILIZATION + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_status | Disk measurement type | Str: ``free``, ``used`` | + +### mongodbatlas.process.asserts + +Number of assertions per second + +Aggregate of MongoDB Metrics ASSERT_REGULAR, ASSERT_USER, ASSERT_MSG, ASSERT_WARNING + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {assertions}/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| assert_type | MongoDB assertion type | Str: ``regular``, ``warning``, ``msg``, ``user`` | + +### mongodbatlas.process.background_flush + +Amount of data flushed in the background + +MongoDB Metric BACKGROUND_FLUSH_AVG + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### mongodbatlas.process.cache.io + +Cache throughput (per second) + +Aggregate of MongoDB Metrics CACHE_BYTES_READ_INTO, CACHE_BYTES_WRITTEN_FROM + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cache_direction | Whether read into or written from | Str: ``read_into``, ``written_from`` | + +### mongodbatlas.process.cache.size + +Cache sizes + +Aggregate of MongoDB Metrics CACHE_USED_BYTES, CACHE_DIRTY_BYTES + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Double | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cache_status | Cache status | Str: ``dirty``, ``used`` | + +### mongodbatlas.process.connections + +Number of current connections + +MongoDB Metric CONNECTIONS + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Double | Cumulative | false | + +### mongodbatlas.process.cpu.children.normalized.usage.average + +CPU Usage for child processes, normalized to pct + +Aggregate of MongoDB Metrics PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL, PROCESS_NORMALIZED_CPU_CHILDREN_USER + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.process.cpu.children.normalized.usage.max + +CPU Usage for child processes, normalized to pct + +Aggregate of MongoDB Metrics MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL, MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.process.cpu.children.usage.average + +CPU Usage for child processes (%) + +Aggregate of MongoDB Metrics PROCESS_CPU_CHILDREN_KERNEL, PROCESS_CPU_CHILDREN_USER + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.process.cpu.children.usage.max + +CPU Usage for child processes (%) + +Aggregate of MongoDB Metrics MAX_PROCESS_CPU_CHILDREN_USER, MAX_PROCESS_CPU_CHILDREN_KERNEL + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.process.cpu.normalized.usage.average + +CPU Usage, normalized to pct + +Aggregate of MongoDB Metrics PROCESS_NORMALIZED_CPU_KERNEL, PROCESS_NORMALIZED_CPU_USER + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.process.cpu.normalized.usage.max + +CPU Usage, normalized to pct + +Aggregate of MongoDB Metrics MAX_PROCESS_NORMALIZED_CPU_USER, MAX_PROCESS_NORMALIZED_CPU_KERNEL + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.process.cpu.usage.average + +CPU Usage (%) + +Aggregate of MongoDB Metrics PROCESS_CPU_KERNEL, PROCESS_CPU_USER + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.process.cpu.usage.max + +CPU Usage (%) + +Aggregate of MongoDB Metrics MAX_PROCESS_CPU_KERNEL, MAX_PROCESS_CPU_USER + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.process.cursors + +Number of cursors + +Aggregate of MongoDB Metrics CURSORS_TOTAL_OPEN, CURSORS_TOTAL_TIMED_OUT + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {cursors} | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cursor_state | Whether cursor is open or timed out | Str: ``timed_out``, ``open`` | + +### mongodbatlas.process.db.document.rate + +Document access rates + +Aggregate of MongoDB Metrics DOCUMENT_METRICS_UPDATED, DOCUMENT_METRICS_DELETED, DOCUMENT_METRICS_RETURNED, DOCUMENT_METRICS_INSERTED + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {documents}/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| document_status | Status of documents in the database | Str: ``returned``, ``inserted``, ``updated``, ``deleted`` | + +### mongodbatlas.process.db.operations.rate + +DB Operation Rates + +Aggregate of MongoDB Metrics OPCOUNTER_GETMORE, OPERATIONS_SCAN_AND_ORDER, OPCOUNTER_UPDATE, OPCOUNTER_REPL_UPDATE, OPCOUNTER_CMD, OPCOUNTER_DELETE, OPCOUNTER_REPL_DELETE, OPCOUNTER_REPL_CMD, OPCOUNTER_QUERY, OPCOUNTER_REPL_INSERT, OPCOUNTER_INSERT + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {operations}/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | Type of database operation | Str: ``cmd``, ``query``, ``update``, ``delete``, ``getmore``, ``insert``, ``scan_and_order`` | +| cluster_role | Whether process is acting as replica or primary | Str: ``primary``, ``replica`` | + +### mongodbatlas.process.db.operations.time + +DB Operation Times + +Aggregate of MongoDB Metrics OP_EXECUTION_TIME_WRITES, OP_EXECUTION_TIME_COMMANDS, OP_EXECUTION_TIME_READS + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Double | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| execution_type | Type of command | Str: ``reads``, ``writes``, ``commands`` | + +### mongodbatlas.process.db.query_executor.scanned + +Scanned objects + +Aggregate of MongoDB Metrics QUERY_EXECUTOR_SCANNED_OBJECTS, QUERY_EXECUTOR_SCANNED + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {objects}/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| scanned_type | Objects or indexes scanned during query | Str: ``index_items``, ``objects`` | + +### mongodbatlas.process.db.query_targeting.scanned_per_returned + +Scanned objects per returned + +Aggregate of MongoDB Metrics QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED, QUERY_TARGETING_SCANNED_PER_RETURNED + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {scanned}/{returned} | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| scanned_type | Objects or indexes scanned during query | Str: ``index_items``, ``objects`` | + +### mongodbatlas.process.db.storage + +Storage used by the database + +Aggregate of MongoDB Metrics DB_INDEX_SIZE_TOTAL, DB_DATA_SIZE_TOTAL_WO_SYSTEM, DB_STORAGE_TOTAL, DB_DATA_SIZE_TOTAL + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| storage_status | Views on database size | Str: ``total``, ``data_size``, ``index_size``, ``data_size_wo_system`` | + +### mongodbatlas.process.fts.cpu.usage + +Full text search CPU (%) + +Aggregate of MongoDB Metrics FTS_PROCESS_CPU_USER, FTS_PROCESS_CPU_KERNEL + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.process.global_lock + +Number and status of locks + +Aggregate of MongoDB Metrics GLOBAL_LOCK_CURRENT_QUEUE_WRITERS, GLOBAL_LOCK_CURRENT_QUEUE_READERS, GLOBAL_LOCK_CURRENT_QUEUE_TOTAL + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {locks} | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| global_lock_state | Which queue is locked | Str: ``current_queue_total``, ``current_queue_readers``, ``current_queue_writers`` | + +### mongodbatlas.process.index.btree_miss_ratio + +Index miss ratio (%) + +MongoDB Metric INDEX_COUNTERS_BTREE_MISS_RATIO + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +### mongodbatlas.process.index.counters + +Indexes + +Aggregate of MongoDB Metrics INDEX_COUNTERS_BTREE_MISSES, INDEX_COUNTERS_BTREE_ACCESSES, INDEX_COUNTERS_BTREE_HITS + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {indexes} | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| btree_counter_type | Database index effectiveness | Str: ``accesses``, ``hits``, ``misses`` | + +### mongodbatlas.process.journaling.commits + +Journaling commits + +MongoDB Metric JOURNALING_COMMITS_IN_WRITE_LOCK + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {commits} | Gauge | Double | + +### mongodbatlas.process.journaling.data_files + +Data file sizes + +MongoDB Metric JOURNALING_WRITE_DATA_FILES_MB + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| MiBy | Gauge | Double | + +### mongodbatlas.process.journaling.written + +Journals written + +MongoDB Metric JOURNALING_MB + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| MiBy | Gauge | Double | + +### mongodbatlas.process.memory.usage + +Memory Usage + +Aggregate of MongoDB Metrics MEMORY_MAPPED, MEMORY_VIRTUAL, COMPUTED_MEMORY, MEMORY_RESIDENT + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| memory_state | Memory usage type | Str: ``resident``, ``virtual``, ``mapped``, ``computed``, ``shared``, ``free``, ``used`` | + +### mongodbatlas.process.network.io + +Network IO + +Aggregate of MongoDB Metrics NETWORK_BYTES_OUT, NETWORK_BYTES_IN + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | Network traffic direction | Str: ``receive``, ``transmit`` | + +### mongodbatlas.process.network.requests + +Network requests + +MongoDB Metric NETWORK_NUM_REQUESTS + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Double | Cumulative | true | + +### mongodbatlas.process.oplog.rate + +Execution rate by operation + +MongoDB Metric OPLOG_RATE_GB_PER_HOUR + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| GiBy/h | Gauge | Double | + +### mongodbatlas.process.oplog.time + +Execution time by operation + +Aggregate of MongoDB Metrics OPLOG_MASTER_TIME, OPLOG_SLAVE_LAG_MASTER_TIME, OPLOG_MASTER_LAG_TIME_DIFF + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| oplog_type | Oplog type | Str: ``slave_lag_master_time``, ``master_time``, ``master_lag_time_diff`` | + +### mongodbatlas.process.page_faults + +Page faults + +Aggregate of MongoDB Metrics GLOBAL_PAGE_FAULT_EXCEPTIONS_THROWN, EXTRA_INFO_PAGE_FAULTS, GLOBAL_ACCESSES_NOT_IN_MEMORY + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {faults}/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| memory_issue_type | Type of memory issue encountered | Str: ``extra_info``, ``global_accesses_not_in_memory``, ``exceptions_thrown`` | + +### mongodbatlas.process.restarts + +Restarts in last hour + +Aggregate of MongoDB Metrics RESTARTS_IN_LAST_HOUR + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {restarts}/h | Gauge | Double | + +### mongodbatlas.process.tickets + +Tickets + +Aggregate of MongoDB Metrics TICKETS_AVAILABLE_WRITE, TICKETS_AVAILABLE_READS + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {tickets} | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| ticket_type | Type of ticket available | Str: ``available_reads``, ``available_writes`` | + +### mongodbatlas.system.cpu.normalized.usage.average + +System CPU Normalized to pct + +Aggregate of MongoDB Metrics SYSTEM_NORMALIZED_CPU_IOWAIT, SYSTEM_NORMALIZED_CPU_GUEST, SYSTEM_NORMALIZED_CPU_IRQ, SYSTEM_NORMALIZED_CPU_KERNEL, SYSTEM_NORMALIZED_CPU_STEAL, SYSTEM_NORMALIZED_CPU_SOFTIRQ, SYSTEM_NORMALIZED_CPU_NICE, SYSTEM_NORMALIZED_CPU_USER + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.system.cpu.normalized.usage.max + +System CPU Normalized to pct + +Aggregate of MongoDB Metrics MAX_SYSTEM_NORMALIZED_CPU_USER, MAX_SYSTEM_NORMALIZED_CPU_NICE, MAX_SYSTEM_NORMALIZED_CPU_IOWAIT, MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ, MAX_SYSTEM_NORMALIZED_CPU_STEAL, MAX_SYSTEM_NORMALIZED_CPU_KERNEL, MAX_SYSTEM_NORMALIZED_CPU_GUEST, MAX_SYSTEM_NORMALIZED_CPU_IRQ + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.system.cpu.usage.average + +System CPU Usage (%) + +Aggregate of MongoDB Metrics SYSTEM_CPU_USER, SYSTEM_CPU_GUEST, SYSTEM_CPU_SOFTIRQ, SYSTEM_CPU_IRQ, SYSTEM_CPU_KERNEL, SYSTEM_CPU_IOWAIT, SYSTEM_CPU_NICE, SYSTEM_CPU_STEAL + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.system.cpu.usage.max + +System CPU Usage (%) + +Aggregate of MongoDB Metrics MAX_SYSTEM_CPU_SOFTIRQ, MAX_SYSTEM_CPU_IRQ, MAX_SYSTEM_CPU_GUEST, MAX_SYSTEM_CPU_IOWAIT, MAX_SYSTEM_CPU_NICE, MAX_SYSTEM_CPU_KERNEL, MAX_SYSTEM_CPU_USER, MAX_SYSTEM_CPU_STEAL + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.system.fts.cpu.normalized.usage + +Full text search disk usage (%) + +Aggregate of MongoDB Metrics FTS_PROCESS_NORMALIZED_CPU_USER, FTS_PROCESS_NORMALIZED_CPU_KERNEL + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.system.fts.cpu.usage + +Full-text search (%) + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| 1 | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| cpu_state | CPU state | Str: ``kernel``, ``user``, ``nice``, ``iowait``, ``irq``, ``softirq``, ``guest``, ``steal`` | + +### mongodbatlas.system.fts.disk.used + +Full text search disk usage + +MongoDB Metric FTS_DISK_USAGE + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Double | + +### mongodbatlas.system.fts.memory.usage + +Full-text search + +Aggregate of MongoDB Metrics FTS_MEMORY_MAPPED, FTS_PROCESS_SHARED_MEMORY, FTS_PROCESS_RESIDENT_MEMORY, FTS_PROCESS_VIRTUAL_MEMORY + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| MiBy | Sum | Double | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| memory_state | Memory usage type | Str: ``resident``, ``virtual``, ``mapped``, ``computed``, ``shared``, ``free``, ``used`` | + +### mongodbatlas.system.memory.usage.average + +System Memory Usage + +Aggregate of MongoDB Metrics SYSTEM_MEMORY_AVAILABLE, SYSTEM_MEMORY_BUFFERS, SYSTEM_MEMORY_USED, SYSTEM_MEMORY_CACHED, SYSTEM_MEMORY_SHARED, SYSTEM_MEMORY_FREE + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| KiBy | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| memory_status | Memory measurement type | Str: ``available``, ``buffers``, ``cached``, ``free``, ``shared``, ``used`` | + +### mongodbatlas.system.memory.usage.max + +System Memory Usage + +Aggregate of MongoDB Metrics MAX_SYSTEM_MEMORY_CACHED, MAX_SYSTEM_MEMORY_AVAILABLE, MAX_SYSTEM_MEMORY_USED, MAX_SYSTEM_MEMORY_BUFFERS, MAX_SYSTEM_MEMORY_FREE, MAX_SYSTEM_MEMORY_SHARED + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| KiBy | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| memory_status | Memory measurement type | Str: ``available``, ``buffers``, ``cached``, ``free``, ``shared``, ``used`` | + +### mongodbatlas.system.network.io.average + +System Network IO + +Aggregate of MongoDB Metrics SYSTEM_NETWORK_IN, SYSTEM_NETWORK_OUT + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | Network traffic direction | Str: ``receive``, ``transmit`` | + +### mongodbatlas.system.network.io.max + +System Network IO + +Aggregate of MongoDB Metrics MAX_SYSTEM_NETWORK_OUT, MAX_SYSTEM_NETWORK_IN + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | Network traffic direction | Str: ``receive``, ``transmit`` | + +### mongodbatlas.system.paging.io.average + +Swap IO + +Aggregate of MongoDB Metrics SWAP_IO_IN, SWAP_IO_OUT + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {pages}/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | Network traffic direction | Str: ``receive``, ``transmit`` | + +### mongodbatlas.system.paging.io.max + +Swap IO + +Aggregate of MongoDB Metrics MAX_SWAP_IO_IN, MAX_SWAP_IO_OUT + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {pages}/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | Network traffic direction | Str: ``receive``, ``transmit`` | + +### mongodbatlas.system.paging.usage.average + +Swap usage + +Aggregate of MongoDB Metrics SWAP_USAGE_FREE, SWAP_USAGE_USED + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| KiBy | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| memory_state | Memory usage type | Str: ``resident``, ``virtual``, ``mapped``, ``computed``, ``shared``, ``free``, ``used`` | + +### mongodbatlas.system.paging.usage.max + +Swap usage + +Aggregate of MongoDB Metrics MAX_SWAP_USAGE_FREE, MAX_SWAP_USAGE_USED + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| KiBy | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| memory_state | Memory usage type | Str: ``resident``, ``virtual``, ``mapped``, ``computed``, ``shared``, ``free``, ``used`` | + +## Resource Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| mongodb_atlas.db.name | Name of the Database | Any Str | +| mongodb_atlas.disk.partition | Name of a disk partition | Any Str | +| mongodb_atlas.host.name | Hostname of the process | Any Str | +| mongodb_atlas.org_name | Organization Name | Any Str | +| mongodb_atlas.process.id | ID of the process | Any Str | +| mongodb_atlas.process.port | Port process is bound to | Any Str | +| mongodb_atlas.process.type_name | Process type | Any Str | +| mongodb_atlas.project.id | Project ID | Any Str | +| mongodb_atlas.project.name | Project Name | Any Str | diff --git a/receiver/mongodbreceiver/documentation.md b/receiver/mongodbreceiver/documentation.md index a43609688b5b..f6643e278dd6 100644 --- a/receiver/mongodbreceiver/documentation.md +++ b/receiver/mongodbreceiver/documentation.md @@ -2,63 +2,560 @@ # mongodbreceiver -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **mongodb.cache.operations** | The number of cache operations of the instance. | {operations} | Sum(Int) |
  • type
| -| **mongodb.collection.count** | The number of collections. | {collections} | Sum(Int) |
  • database
| -| **mongodb.connection.count** | The number of connections. | {connections} | Sum(Int) |
  • database
  • connection_type
| -| **mongodb.cursor.count** | The number of open cursors maintained for clients. | {cursors} | Sum(Int) |
| -| **mongodb.cursor.timeout.count** | The number of cursors that have timed out. | {cursors} | Sum(Int) |
| -| **mongodb.data.size** | The size of the collection. Data compression does not affect this value. | By | Sum(Int) |
  • database
| -| **mongodb.database.count** | The number of existing databases. | {databases} | Sum(Int) |
| -| **mongodb.document.operation.count** | The number of document operations executed. | {documents} | Sum(Int) |
  • database
  • operation
| -| **mongodb.extent.count** | The number of extents. | {extents} | Sum(Int) |
  • database
| -| **mongodb.global_lock.time** | The time the global lock has been held. | ms | Sum(Int) |
| -| **mongodb.index.access.count** | The number of times an index has been accessed. | {accesses} | Sum(Int) |
  • database
  • collection
| -| **mongodb.index.count** | The number of indexes. | {indexes} | Sum(Int) |
  • database
| -| **mongodb.index.size** | Sum of the space allocated to all indexes in the database, including free index space. | By | Sum(Int) |
  • database
| -| mongodb.lock.acquire.count | Number of times the lock was acquired in the specified mode. | {count} | Sum(Int) |
  • database
  • lock_type
  • lock_mode
| -| mongodb.lock.acquire.time | Cumulative wait time for the lock acquisitions. | microseconds | Sum(Int) |
  • database
  • lock_type
  • lock_mode
| -| mongodb.lock.acquire.wait_count | Number of times the lock acquisitions encountered waits because the locks were held in a conflicting mode. | {count} | Sum(Int) |
  • database
  • lock_type
  • lock_mode
| -| mongodb.lock.deadlock.count | Number of times the lock acquisitions encountered deadlocks. | {count} | Sum(Int) |
  • database
  • lock_type
  • lock_mode
| -| **mongodb.memory.usage** | The amount of memory used. | By | Sum(Int) |
  • database
  • memory_type
| -| **mongodb.network.io.receive** | The number of bytes received. | By | Sum(Int) |
| -| **mongodb.network.io.transmit** | The number of by transmitted. | By | Sum(Int) |
| -| **mongodb.network.request.count** | The number of requests received by the server. | {requests} | Sum(Int) |
| -| **mongodb.object.count** | The number of objects. | {objects} | Sum(Int) |
  • database
| -| **mongodb.operation.count** | The number of operations executed. | {operations} | Sum(Int) |
  • operation
| -| **mongodb.operation.time** | The total time spent performing operations. | ms | Sum(Int) |
  • operation
| -| **mongodb.session.count** | The total number of active sessions. | {sessions} | Sum(Int) |
| -| **mongodb.storage.size** | The total amount of storage allocated to this collection. If collection data is compressed it reflects the compressed size. | By | Sum(Int) |
  • database
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: + +```yaml +metrics: + : + enabled: false +``` + +### mongodb.cache.operations + +The number of cache operations of the instance. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | The result of a cache request. | Str: ``hit``, ``miss`` | + +### mongodb.collection.count + +The number of collections. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {collections} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of a database. | Any Str | + +### mongodb.connection.count + +The number of connections. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of a database. | Any Str | +| type | The status of the connection. | Str: ``active``, ``available``, ``current`` | + +### mongodb.cursor.count + +The number of open cursors maintained for clients. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {cursors} | Sum | Int | Cumulative | false | + +### mongodb.cursor.timeout.count + +The number of cursors that have timed out. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {cursors} | Sum | Int | Cumulative | false | + +### mongodb.data.size + +The size of the collection. Data compression does not affect this value. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of a database. | Any Str | + +### mongodb.database.count + +The number of existing databases. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {databases} | Sum | Int | Cumulative | false | + +### mongodb.document.operation.count + +The number of document operations executed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {documents} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of a database. | Any Str | +| operation | The MongoDB operation being counted. | Str: ``insert``, ``query``, ``update``, ``delete``, ``getmore``, ``command`` | + +### mongodb.extent.count + +The number of extents. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {extents} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of a database. | Any Str | + +### mongodb.global_lock.time + +The time the global lock has been held. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Int | Cumulative | true | + +### mongodb.index.access.count + +The number of times an index has been accessed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {accesses} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of a database. | Any Str | +| collection | The name of a collection. | Any Str | + +### mongodb.index.count + +The number of indexes. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {indexes} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of a database. | Any Str | + +### mongodb.index.size + +Sum of the space allocated to all indexes in the database, including free index space. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of a database. | Any Str | + +### mongodb.memory.usage + +The amount of memory used. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of a database. | Any Str | +| type | The type of memory used. | Str: ``resident``, ``virtual`` | + +### mongodb.network.io.receive + +The number of bytes received. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### mongodb.network.io.transmit + +The number of by transmitted. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### mongodb.network.request.count + +The number of requests received by the server. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | false | + +### mongodb.object.count + +The number of objects. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {objects} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of a database. | Any Str | + +### mongodb.operation.count + +The number of operations executed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The MongoDB operation being counted. | Str: ``insert``, ``query``, ``update``, ``delete``, ``getmore``, ``command`` | + +### mongodb.operation.time + +The total time spent performing operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The MongoDB operation being counted. | Str: ``insert``, ``query``, ``update``, ``delete``, ``getmore``, ``command`` | + +### mongodb.session.count + +The total number of active sessions. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {sessions} | Sum | Int | Cumulative | false | + +### mongodb.storage.size + +The total amount of storage allocated to this collection. + +If collection data is compressed it reflects the compressed size. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of a database. | Any Str | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Resource attributes +### mongodb.cache.operations + +The number of cache operations of the instance. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | The result of a cache request. | Str: ``hit``, ``miss`` | + +### mongodb.collection.count + +The number of collections. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {collections} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of a database. | Any Str | + +### mongodb.connection.count + +The number of connections. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of a database. | Any Str | +| type | The status of the connection. | Str: ``active``, ``available``, ``current`` | + +### mongodb.cursor.count + +The number of open cursors maintained for clients. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {cursors} | Sum | Int | Cumulative | false | + +### mongodb.cursor.timeout.count + +The number of cursors that have timed out. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {cursors} | Sum | Int | Cumulative | false | + +### mongodb.data.size + +The size of the collection. Data compression does not affect this value. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of a database. | Any Str | + +### mongodb.database.count + +The number of existing databases. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {databases} | Sum | Int | Cumulative | false | + +### mongodb.document.operation.count + +The number of document operations executed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {documents} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of a database. | Any Str | +| operation | The MongoDB operation being counted. | Str: ``insert``, ``query``, ``update``, ``delete``, ``getmore``, ``command`` | + +### mongodb.extent.count + +The number of extents. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {extents} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of a database. | Any Str | + +### mongodb.global_lock.time + +The time the global lock has been held. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Int | Cumulative | true | + +### mongodb.index.access.count + +The number of times an index has been accessed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {accesses} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of a database. | Any Str | +| collection | The name of a collection. | Any Str | + +### mongodb.index.count + +The number of indexes. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {indexes} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of a database. | Any Str | + +### mongodb.index.size + +Sum of the space allocated to all indexes in the database, including free index space. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of a database. | Any Str | + +### mongodb.memory.usage + +The amount of memory used. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of a database. | Any Str | +| type | The type of memory used. | Str: ``resident``, ``virtual`` | + +### mongodb.network.io.receive + +The number of bytes received. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### mongodb.network.io.transmit + +The number of by transmitted. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### mongodb.network.request.count + +The number of requests received by the server. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | false | -| Name | Description | Type | -| ---- | ----------- | ---- | -| database | The name of a database. | Str | +### mongodb.object.count + +The number of objects. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {objects} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of a database. | Any Str | + +### mongodb.operation.count + +The number of operations executed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The MongoDB operation being counted. | Str: ``insert``, ``query``, ``update``, ``delete``, ``getmore``, ``command`` | + +### mongodb.operation.time + +The total time spent performing operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The MongoDB operation being counted. | Str: ``insert``, ``query``, ``update``, ``delete``, ``getmore``, ``command`` | + +### mongodb.session.count + +The total number of active sessions. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {sessions} | Sum | Int | Cumulative | false | + +### mongodb.storage.size + +The total amount of storage allocated to this collection. + +If collection data is compressed it reflects the compressed size. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of a database. | Any Str | -## Metric attributes +## Resource Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| collection | The name of a collection. | | -| connection_type (type) | The status of the connection. | active, available, current | -| database | The name of a database. | | -| lock_mode | The mode of Lock which denotes the degree of access | shared, exclusive, intent_shared, intent_exclusive | -| lock_type | The Resource over which the Lock controls access | parallel_batch_write_mode, replication_state_transition, global, database, collection, mutex, metadata, oplog | -| memory_type (type) | The type of memory used. | resident, virtual | -| operation | The MongoDB operation being counted. | insert, query, update, delete, getmore, command | -| type | The result of a cache request. | hit, miss | +| database | The name of a database. | Any Str | diff --git a/receiver/mysqlreceiver/documentation.md b/receiver/mysqlreceiver/documentation.md index e7c0636518f9..af1eb103057f 100644 --- a/receiver/mysqlreceiver/documentation.md +++ b/receiver/mysqlreceiver/documentation.md @@ -2,100 +2,744 @@ # mysqlreceiver -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **mysql.buffer_pool.data_pages** | The number of data pages in the InnoDB buffer pool. | 1 | Sum(Int) |
  • buffer_pool_data
| -| **mysql.buffer_pool.limit** | The configured size of the InnoDB buffer pool. | By | Sum(Int) |
| -| **mysql.buffer_pool.operations** | The number of operations on the InnoDB buffer pool. | 1 | Sum(Int) |
  • buffer_pool_operations
| -| **mysql.buffer_pool.page_flushes** | The number of requests to flush pages from the InnoDB buffer pool. | 1 | Sum(Int) |
| -| **mysql.buffer_pool.pages** | The number of pages in the InnoDB buffer pool. | 1 | Sum(Int) |
  • buffer_pool_pages
| -| **mysql.buffer_pool.usage** | The number of bytes in the InnoDB buffer pool. | By | Sum(Int) |
  • buffer_pool_data
| -| mysql.client.network.io | The number of transmitted bytes between server and clients. | By | Sum(Int) |
  • direction
| -| **mysql.commands** | The number of times each type of command has been executed. | 1 | Sum(Int) |
  • prepared_statements_command
| -| mysql.connection.errors | Errors that occur during the client connection process. | 1 | Sum(Int) |
  • connection_error
| -| **mysql.double_writes** | The number of writes to the InnoDB doublewrite buffer. | 1 | Sum(Int) |
  • double_writes
| -| **mysql.handlers** | The number of requests to various MySQL handlers. | 1 | Sum(Int) |
  • handler
| -| **mysql.index.io.wait.count** | The total count of I/O wait events for an index. | 1 | Sum(Int) |
  • io_waits_operations
  • table_name
  • schema
  • index_name
| -| **mysql.index.io.wait.time** | The total time of I/O wait events for an index. | ns | Sum(Int) |
  • io_waits_operations
  • table_name
  • schema
  • index_name
| -| mysql.joins | The number of joins that perform table scans. | 1 | Sum(Int) |
  • join_kind
| -| **mysql.locked_connects** | The number of attempts to connect to locked user accounts. | 1 | Sum(Int) |
| -| **mysql.locks** | The number of MySQL locks. | 1 | Sum(Int) |
  • locks
| -| **mysql.log_operations** | The number of InnoDB log operations. | 1 | Sum(Int) |
  • log_operations
| -| **mysql.mysqlx_connections** | The number of mysqlx connections. This metric is specific for MySQL working as Document Store (X-Plugin). [more docs](https://dev.mysql.com/doc/refman/8.0/en/document-store.html) | 1 | Sum(Int) |
  • connection_status
| -| mysql.mysqlx_worker_threads | The number of worker threads available. This metric is specific for MySQL working as Document Store (X-Plugin). [more docs](https://dev.mysql.com/doc/refman/8.0/en/document-store.html) | 1 | Sum(Int) |
  • mysqlx_threads
| -| **mysql.opened_resources** | The number of opened resources. | 1 | Sum(Int) |
  • opened_resources
| -| **mysql.operations** | The number of InnoDB operations. | 1 | Sum(Int) |
  • operations
| -| **mysql.page_operations** | The number of InnoDB page operations. | 1 | Sum(Int) |
  • page_operations
| -| **mysql.prepared_statements** | The number of times each type of prepared statement command has been issued. | 1 | Sum(Int) |
  • prepared_statements_command
| -| mysql.query.client.count | The number of statements executed by the server. This includes only statements sent to the server by clients. | 1 | Sum(Int) |
| -| mysql.query.count | The number of statements executed by the server. | 1 | Sum(Int) |
| -| mysql.query.slow.count | The number of slow queries. | 1 | Sum(Int) |
| -| **mysql.row_locks** | The number of InnoDB row locks. | 1 | Sum(Int) |
  • row_locks
| -| **mysql.row_operations** | The number of InnoDB row operations. | 1 | Sum(Int) |
  • row_operations
| -| **mysql.sorts** | The number of MySQL sorts. | 1 | Sum(Int) |
  • sorts
| -| mysql.statement_event.count | Summary of current and recent statement events. | 1 | Sum(Int) |
  • schema
  • digest
  • digest_text
  • event_state
| -| mysql.statement_event.wait.time | The total wait time of the summarized timed events. | ns | Sum(Int) |
  • schema
  • digest
  • digest_text
| -| **mysql.table.io.wait.count** | The total count of I/O wait events for a table. | 1 | Sum(Int) |
  • io_waits_operations
  • table_name
  • schema
| -| **mysql.table.io.wait.time** | The total time of I/O wait events for a table. | ns | Sum(Int) |
  • io_waits_operations
  • table_name
  • schema
| -| mysql.table.lock_wait.read.count | The total table lock wait read events. | 1 | Sum(Int) |
  • schema
  • table_name
  • read_lock_type
| -| mysql.table.lock_wait.read.time | The total table lock wait read events times. | ns | Sum(Int) |
  • schema
  • table_name
  • read_lock_type
| -| mysql.table.lock_wait.write.count | The total table lock wait write events. | 1 | Sum(Int) |
  • schema
  • table_name
  • write_lock_type
| -| mysql.table.lock_wait.write.time | The total table lock wait write events times. | ns | Sum(Int) |
  • schema
  • table_name
  • write_lock_type
| -| mysql.table_open_cache | The number of hits, misses or overflows for open tables cache lookups. | 1 | Sum(Int) |
  • cache_status
| -| **mysql.threads** | The state of MySQL threads. | 1 | Sum(Int) |
  • threads
| -| **mysql.tmp_resources** | The number of created temporary resources. | 1 | Sum(Int) |
  • tmp_resource
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: false ``` -## Resource attributes - -| Name | Description | Type | -| ---- | ----------- | ---- | -| mysql.instance.endpoint | Endpoint of the MySQL instance. | Str | - -## Metric attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| buffer_pool_data (status) | The status of buffer pool data. | dirty, clean | -| buffer_pool_operations (operation) | The buffer pool operations types. | read_ahead_rnd, read_ahead, read_ahead_evicted, read_requests, reads, wait_free, write_requests | -| buffer_pool_pages (kind) | The buffer pool pages types. | data, free, misc | -| cache_status (status) | The status of cache access. | hit, miss, overflow | -| connection_error (error) | The connection error type. | accept, internal, max_connections, peer_address, select, tcpwrap | -| connection_status (status) | The connection status. | accepted, closed, rejected | -| digest (digest) | Digest. | | -| digest_text (digest_text) | Text before digestion. | | -| direction (kind) | The name of the transmission direction. | received, sent | -| double_writes (kind) | The doublewrite types. | pages_written, writes | -| event_state (kind) | Possible event states. | errors, warnings, rows_affected, rows_sent, rows_examined, created_tmp_disk_tables, created_tmp_tables, sort_merge_passes, sort_rows, no_index_used | -| handler (kind) | The handler types. | commit, delete, discover, external_lock, mrr_init, prepare, read_first, read_key, read_last, read_next, read_prev, read_rnd, read_rnd_next, rollback, savepoint, savepoint_rollback, update, write | -| index_name (index) | The name of the index. | | -| io_waits_operations (operation) | The io_waits operation type. | delete, fetch, insert, update | -| join_kind (kind) | The kind of join. | full, full_range, range, range_check, scan | -| locks (kind) | The table locks type. | immediate, waited | -| log_operations (operation) | The log operation types. | waits, write_requests, writes | -| mysqlx_threads (kind) | The worker thread count kind. | available, active | -| opened_resources (kind) | The kind of the resource. | file, table_definition, table | -| operations (operation) | The operation types. | fsyncs, reads, writes | -| page_operations (operation) | The page operation types. | created, read, written | -| prepared_statements_command (command) | The prepare statement command types. | execute, close, fetch, prepare, reset, send_long_data | -| read_lock_type (kind) | Read operation types. | normal, with_shared_locks, high_priority, no_insert, external | -| row_locks (kind) | The row lock type. | waits, time | -| row_operations (operation) | The row operation type. | deleted, inserted, read, updated | -| schema (schema) | The schema of the object. | | -| sorts (kind) | The sort count type. | merge_passes, range, rows, scan | -| table_name (table) | Table name for event or process. | | -| threads (kind) | The thread count type. | cached, connected, created, running | -| tmp_resource (resource) | The kind of temporary resources. | disk_tables, files, tables | -| write_lock_type (kind) | Write operation types. | allow_write, concurrent_insert, low_priority, normal, external | +### mysql.buffer_pool.data_pages + +The number of data pages in the InnoDB buffer pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The status of buffer pool data. | Str: ``dirty``, ``clean`` | + +### mysql.buffer_pool.limit + +The configured size of the InnoDB buffer pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### mysql.buffer_pool.operations + +The number of operations on the InnoDB buffer pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The buffer pool operations types. | Str: ``read_ahead_rnd``, ``read_ahead``, ``read_ahead_evicted``, ``read_requests``, ``reads``, ``wait_free``, ``write_requests`` | + +### mysql.buffer_pool.page_flushes + +The number of requests to flush pages from the InnoDB buffer pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +### mysql.buffer_pool.pages + +The number of pages in the InnoDB buffer pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| kind | The buffer pool pages types. | Str: ``data``, ``free``, ``misc`` | + +### mysql.buffer_pool.usage + +The number of bytes in the InnoDB buffer pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The status of buffer pool data. | Str: ``dirty``, ``clean`` | + +### mysql.commands + +The number of times each type of command has been executed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| command | The prepare statement command types. | Str: ``execute``, ``close``, ``fetch``, ``prepare``, ``reset``, ``send_long_data`` | + +### mysql.double_writes + +The number of writes to the InnoDB doublewrite buffer. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| kind | The doublewrite types. | Str: ``pages_written``, ``writes`` | + +### mysql.handlers + +The number of requests to various MySQL handlers. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| kind | The handler types. | Str: ``commit``, ``delete``, ``discover``, ``external_lock``, ``mrr_init``, ``prepare``, ``read_first``, ``read_key``, ``read_last``, ``read_next``, ``read_prev``, ``read_rnd``, ``read_rnd_next``, ``rollback``, ``savepoint``, ``savepoint_rollback``, ``update``, ``write`` | + +### mysql.index.io.wait.count + +The total count of I/O wait events for an index. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The io_waits operation type. | Str: ``delete``, ``fetch``, ``insert``, ``update`` | +| table | Table name for event or process. | Any Str | +| schema | The schema of the object. | Any Str | +| index | The name of the index. | Any Str | + +### mysql.index.io.wait.time + +The total time of I/O wait events for an index. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ns | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The io_waits operation type. | Str: ``delete``, ``fetch``, ``insert``, ``update`` | +| table | Table name for event or process. | Any Str | +| schema | The schema of the object. | Any Str | +| index | The name of the index. | Any Str | + +### mysql.locked_connects + +The number of attempts to connect to locked user accounts. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +### mysql.locks + +The number of MySQL locks. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| kind | The table locks type. | Str: ``immediate``, ``waited`` | + +### mysql.log_operations + +The number of InnoDB log operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The log operation types. | Str: ``waits``, ``write_requests``, ``writes`` | + +### mysql.mysqlx_connections + +The number of mysqlx connections. + +This metric is specific for MySQL working as Document Store (X-Plugin). [more docs](https://dev.mysql.com/doc/refman/8.0/en/document-store.html) + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The connection status. | Str: ``accepted``, ``closed``, ``rejected`` | + +### mysql.opened_resources + +The number of opened resources. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| kind | The kind of the resource. | Str: ``file``, ``table_definition``, ``table`` | + +### mysql.operations + +The number of InnoDB operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The operation types. | Str: ``fsyncs``, ``reads``, ``writes`` | + +### mysql.page_operations + +The number of InnoDB page operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The page operation types. | Str: ``created``, ``read``, ``written`` | + +### mysql.prepared_statements + +The number of times each type of prepared statement command has been issued. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| command | The prepare statement command types. | Str: ``execute``, ``close``, ``fetch``, ``prepare``, ``reset``, ``send_long_data`` | + +### mysql.row_locks + +The number of InnoDB row locks. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| kind | The row lock type. | Str: ``waits``, ``time`` | + +### mysql.row_operations + +The number of InnoDB row operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The row operation type. | Str: ``deleted``, ``inserted``, ``read``, ``updated`` | + +### mysql.sorts + +The number of MySQL sorts. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| kind | The sort count type. | Str: ``merge_passes``, ``range``, ``rows``, ``scan`` | + +### mysql.table.io.wait.count + +The total count of I/O wait events for a table. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The io_waits operation type. | Str: ``delete``, ``fetch``, ``insert``, ``update`` | +| table | Table name for event or process. | Any Str | +| schema | The schema of the object. | Any Str | + +### mysql.table.io.wait.time + +The total time of I/O wait events for a table. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ns | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The io_waits operation type. | Str: ``delete``, ``fetch``, ``insert``, ``update`` | +| table | Table name for event or process. | Any Str | +| schema | The schema of the object. | Any Str | + +### mysql.threads + +The state of MySQL threads. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| kind | The thread count type. | Str: ``cached``, ``connected``, ``created``, ``running`` | + +### mysql.tmp_resources + +The number of created temporary resources. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| resource | The kind of temporary resources. | Str: ``disk_tables``, ``files``, ``tables`` | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: + +```yaml +metrics: + : + enabled: true +``` + +### mysql.buffer_pool.data_pages + +The number of data pages in the InnoDB buffer pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The status of buffer pool data. | Str: ``dirty``, ``clean`` | + +### mysql.buffer_pool.limit + +The configured size of the InnoDB buffer pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### mysql.buffer_pool.operations + +The number of operations on the InnoDB buffer pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The buffer pool operations types. | Str: ``read_ahead_rnd``, ``read_ahead``, ``read_ahead_evicted``, ``read_requests``, ``reads``, ``wait_free``, ``write_requests`` | + +### mysql.buffer_pool.page_flushes + +The number of requests to flush pages from the InnoDB buffer pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +### mysql.buffer_pool.pages + +The number of pages in the InnoDB buffer pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| kind | The buffer pool pages types. | Str: ``data``, ``free``, ``misc`` | + +### mysql.buffer_pool.usage + +The number of bytes in the InnoDB buffer pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The status of buffer pool data. | Str: ``dirty``, ``clean`` | + +### mysql.commands + +The number of times each type of command has been executed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| command | The prepare statement command types. | Str: ``execute``, ``close``, ``fetch``, ``prepare``, ``reset``, ``send_long_data`` | + +### mysql.double_writes + +The number of writes to the InnoDB doublewrite buffer. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| kind | The doublewrite types. | Str: ``pages_written``, ``writes`` | + +### mysql.handlers + +The number of requests to various MySQL handlers. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| kind | The handler types. | Str: ``commit``, ``delete``, ``discover``, ``external_lock``, ``mrr_init``, ``prepare``, ``read_first``, ``read_key``, ``read_last``, ``read_next``, ``read_prev``, ``read_rnd``, ``read_rnd_next``, ``rollback``, ``savepoint``, ``savepoint_rollback``, ``update``, ``write`` | + +### mysql.index.io.wait.count + +The total count of I/O wait events for an index. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The io_waits operation type. | Str: ``delete``, ``fetch``, ``insert``, ``update`` | +| table | Table name for event or process. | Any Str | +| schema | The schema of the object. | Any Str | +| index | The name of the index. | Any Str | + +### mysql.index.io.wait.time + +The total time of I/O wait events for an index. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ns | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The io_waits operation type. | Str: ``delete``, ``fetch``, ``insert``, ``update`` | +| table | Table name for event or process. | Any Str | +| schema | The schema of the object. | Any Str | +| index | The name of the index. | Any Str | + +### mysql.locked_connects + +The number of attempts to connect to locked user accounts. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +### mysql.locks + +The number of MySQL locks. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| kind | The table locks type. | Str: ``immediate``, ``waited`` | + +### mysql.log_operations + +The number of InnoDB log operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The log operation types. | Str: ``waits``, ``write_requests``, ``writes`` | + +### mysql.mysqlx_connections + +The number of mysqlx connections. + +This metric is specific for MySQL working as Document Store (X-Plugin). [more docs](https://dev.mysql.com/doc/refman/8.0/en/document-store.html) + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The connection status. | Str: ``accepted``, ``closed``, ``rejected`` | + +### mysql.opened_resources + +The number of opened resources. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| kind | The kind of the resource. | Str: ``file``, ``table_definition``, ``table`` | + +### mysql.operations + +The number of InnoDB operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The operation types. | Str: ``fsyncs``, ``reads``, ``writes`` | + +### mysql.page_operations + +The number of InnoDB page operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The page operation types. | Str: ``created``, ``read``, ``written`` | + +### mysql.prepared_statements + +The number of times each type of prepared statement command has been issued. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| command | The prepare statement command types. | Str: ``execute``, ``close``, ``fetch``, ``prepare``, ``reset``, ``send_long_data`` | + +### mysql.row_locks + +The number of InnoDB row locks. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| kind | The row lock type. | Str: ``waits``, ``time`` | + +### mysql.row_operations + +The number of InnoDB row operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The row operation type. | Str: ``deleted``, ``inserted``, ``read``, ``updated`` | + +### mysql.sorts + +The number of MySQL sorts. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| kind | The sort count type. | Str: ``merge_passes``, ``range``, ``rows``, ``scan`` | + +### mysql.table.io.wait.count + +The total count of I/O wait events for a table. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The io_waits operation type. | Str: ``delete``, ``fetch``, ``insert``, ``update`` | +| table | Table name for event or process. | Any Str | +| schema | The schema of the object. | Any Str | + +### mysql.table.io.wait.time + +The total time of I/O wait events for a table. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ns | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The io_waits operation type. | Str: ``delete``, ``fetch``, ``insert``, ``update`` | +| table | Table name for event or process. | Any Str | +| schema | The schema of the object. | Any Str | + +### mysql.threads + +The state of MySQL threads. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| kind | The thread count type. | Str: ``cached``, ``connected``, ``created``, ``running`` | + +### mysql.tmp_resources + +The number of created temporary resources. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| resource | The kind of temporary resources. | Str: ``disk_tables``, ``files``, ``tables`` | + +## Resource Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| mysql.instance.endpoint | Endpoint of the MySQL instance. | Any Str | diff --git a/receiver/nginxreceiver/documentation.md b/receiver/nginxreceiver/documentation.md index 804831a7ae2b..e80424b90c91 100644 --- a/receiver/nginxreceiver/documentation.md +++ b/receiver/nginxreceiver/documentation.md @@ -2,28 +2,98 @@ # nginxreceiver -## Metrics +## Default Metrics -These are the metrics available for this scraper. +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **nginx.connections_accepted** | The total number of accepted client connections | connections | Sum(Int) |
| -| **nginx.connections_current** | The current number of nginx connections by state | connections | Gauge(Int) |
  • state
| -| **nginx.connections_handled** | The total number of handled connections. Generally, the parameter value is the same as nginx.connections_accepted unless some resource limits have been reached (for example, the worker_connections limit). | connections | Sum(Int) |
| -| **nginx.requests** | Total number of requests made to the server since it started | requests | Sum(Int) |
| +```yaml +metrics: + : + enabled: false +``` + +### nginx.connections_accepted + +The total number of accepted client connections + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| connections | Sum | Int | Cumulative | true | + +### nginx.connections_current + +The current number of nginx connections by state + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| connections | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | The state of a connection | Str: ``active``, ``reading``, ``writing``, ``waiting`` | + +### nginx.connections_handled + +The total number of handled connections. Generally, the parameter value is the same as nginx.connections_accepted unless some resource limits have been reached (for example, the worker_connections limit). + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| connections | Sum | Int | Cumulative | true | -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +### nginx.requests + +Total number of requests made to the server since it started + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| requests | Sum | Int | Cumulative | true | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Metric attributes +### nginx.connections_accepted + +The total number of accepted client connections + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| connections | Sum | Int | Cumulative | true | + +### nginx.connections_current + +The current number of nginx connections by state + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| connections | Gauge | Int | + +#### Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| state | The state of a connection | active, reading, writing, waiting | +| state | The state of a connection | Str: ``active``, ``reading``, ``writing``, ``waiting`` | + +### nginx.connections_handled + +The total number of handled connections. Generally, the parameter value is the same as nginx.connections_accepted unless some resource limits have been reached (for example, the worker_connections limit). + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| connections | Sum | Int | Cumulative | true | + +### nginx.requests + +Total number of requests made to the server since it started + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| requests | Sum | Int | Cumulative | true | diff --git a/receiver/nsxtreceiver/documentation.md b/receiver/nsxtreceiver/documentation.md index 4ec04afdf7ae..dde06666e2b4 100644 --- a/receiver/nsxtreceiver/documentation.md +++ b/receiver/nsxtreceiver/documentation.md @@ -2,43 +2,193 @@ # nsxtreceiver -## Metrics +## Default Metrics -These are the metrics available for this scraper. +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **nsxt.node.cpu.utilization** | The average amount of CPU being used by the node. | % | Gauge(Double) |
  • class
| -| **nsxt.node.filesystem.usage** | The amount of storage space used by the node. | By | Sum(Int) |
  • disk_state
| -| **nsxt.node.filesystem.utilization** | The percentage of storage space utilized. | % | Gauge(Double) |
| -| **nsxt.node.memory.cache.usage** | The size of the node's memory cache. | KBy | Sum(Int) |
| -| **nsxt.node.memory.usage** | The memory usage of the node. | KBy | Sum(Int) |
| -| **nsxt.node.network.io** | The number of bytes which have flowed through the network interface. | By | Sum(Int) |
  • direction
| -| **nsxt.node.network.packet.count** | The number of packets which have flowed through the network interface on the node. | {packets} | Sum(Int) |
  • direction
  • packet.type
| +```yaml +metrics: + : + enabled: false +``` + +### nsxt.node.cpu.utilization + +The average amount of CPU being used by the node. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| class | The CPU usage of the architecture allocated for either DPDK (datapath) or non-DPDK (services) processes. | Str: ``datapath``, ``services`` | + +### nsxt.node.filesystem.usage + +The amount of storage space used by the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | The state of storage space. | Str: ``used``, ``available`` | + +### nsxt.node.filesystem.utilization + +The percentage of storage space utilized. -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +### nsxt.node.memory.cache.usage + +The size of the node's memory cache. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| KBy | Sum | Int | Cumulative | false | + +### nsxt.node.memory.usage + +The memory usage of the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| KBy | Sum | Int | Cumulative | false | + +### nsxt.node.network.io + +The number of bytes which have flowed through the network interface. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of network flow. | Str: ``received``, ``transmitted`` | + +### nsxt.node.network.packet.count + +The number of packets which have flowed through the network interface on the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of network flow. | Str: ``received``, ``transmitted`` | +| type | The type of packet counter. | Str: ``dropped``, ``errored``, ``success`` | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Resource attributes +### nsxt.node.cpu.utilization + +The average amount of CPU being used by the node. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| class | The CPU usage of the architecture allocated for either DPDK (datapath) or non-DPDK (services) processes. | Str: ``datapath``, ``services`` | + +### nsxt.node.filesystem.usage + +The amount of storage space used by the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | The state of storage space. | Str: ``used``, ``available`` | + +### nsxt.node.filesystem.utilization + +The percentage of storage space utilized. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | -| Name | Description | Type | -| ---- | ----------- | ---- | -| device.id | The name of the network interface. | Str | -| nsxt.node.id | The ID of the NSX Node. | Str | -| nsxt.node.name | The name of the NSX Node. | Str | -| nsxt.node.type | The type of NSX Node. | Str | +### nsxt.node.memory.cache.usage + +The size of the node's memory cache. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| KBy | Sum | Int | Cumulative | false | + +### nsxt.node.memory.usage + +The memory usage of the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| KBy | Sum | Int | Cumulative | false | + +### nsxt.node.network.io + +The number of bytes which have flowed through the network interface. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of network flow. | Str: ``received``, ``transmitted`` | + +### nsxt.node.network.packet.count + +The number of packets which have flowed through the network interface on the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of network flow. | Str: ``received``, ``transmitted`` | +| type | The type of packet counter. | Str: ``dropped``, ``errored``, ``success`` | -## Metric attributes +## Resource Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| class | The CPU usage of the architecture allocated for either DPDK (datapath) or non-DPDK (services) processes. | datapath, services | -| direction (direction) | The direction of network flow. | received, transmitted | -| disk_state (state) | The state of storage space. | used, available | -| packet.type (type) | The type of packet counter. | dropped, errored, success | +| device.id | The name of the network interface. | Any Str | +| nsxt.node.id | The ID of the NSX Node. | Any Str | +| nsxt.node.name | The name of the NSX Node. | Any Str | +| nsxt.node.type | The type of NSX Node. | Any Str | diff --git a/receiver/oracledbreceiver/documentation.md b/receiver/oracledbreceiver/documentation.md index fec9e281a3bf..0e66c6570ffd 100644 --- a/receiver/oracledbreceiver/documentation.md +++ b/receiver/oracledbreceiver/documentation.md @@ -2,57 +2,466 @@ # oracledbreceiver -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **oracledb.cpu_time** | Cumulative CPU time, in seconds | s | Sum(Double) |
| -| **oracledb.dml_locks.limit** | Maximum limit of active DML (Data Manipulation Language) locks. | {locks} | Gauge(Int) |
| -| **oracledb.dml_locks.usage** | Current count of active DML (Data Manipulation Language) locks. | {locks} | Gauge(Int) |
| -| **oracledb.enqueue_deadlocks** | Total number of deadlocks between table or row locks in different sessions. | {deadlocks} | Sum(Int) |
| -| **oracledb.enqueue_locks.limit** | Maximum limit of active enqueue locks. | {locks} | Gauge(Int) |
| -| **oracledb.enqueue_locks.usage** | Current count of active enqueue locks. | {locks} | Gauge(Int) |
| -| **oracledb.enqueue_resources.limit** | Maximum limit of active enqueue resources. | {resources} | Gauge(Int) |
| -| **oracledb.enqueue_resources.usage** | Current count of active enqueue resources. | {resources} | Gauge(Int) |
| -| **oracledb.exchange_deadlocks** | Number of times that a process detected a potential deadlock when exchanging two buffers and raised an internal, restartable error. Index scans are the only operations that perform exchanges. | {deadlocks} | Sum(Int) |
| -| **oracledb.executions** | Total number of calls (user and recursive) that executed SQL statements | {executions} | Sum(Int) |
| -| **oracledb.hard_parses** | Number of hard parses | {parses} | Sum(Int) |
| -| **oracledb.logical_reads** | Number of logical reads | {reads} | Sum(Int) |
| -| **oracledb.parse_calls** | Total number of parse calls. | {parses} | Sum(Int) |
| -| **oracledb.pga_memory** | Session PGA (Program Global Area) memory | By | Sum(Int) |
| -| **oracledb.physical_reads** | Number of physical reads | {reads} | Sum(Int) |
| -| **oracledb.processes.limit** | Maximum limit of active processes. | {processes} | Gauge(Int) |
| -| **oracledb.processes.usage** | Current count of active processes. | {processes} | Gauge(Int) |
| -| **oracledb.sessions.limit** | Maximum limit of active sessions. | {sessions} | Gauge(Int) |
| -| **oracledb.sessions.usage** | Count of active sessions. | {sessions} | Gauge(Int) |
  • session_type
  • session_status
| -| **oracledb.tablespace_size.limit** | Maximum size of tablespace in bytes. | By | Gauge(Int) |
  • tablespace_name
| -| **oracledb.tablespace_size.usage** | Used tablespace in bytes. | By | Gauge(Int) |
  • tablespace_name
| -| **oracledb.transactions.limit** | Maximum limit of active transactions. | {transactions} | Gauge(Int) |
| -| **oracledb.transactions.usage** | Current count of active transactions. | {transactions} | Gauge(Int) |
| -| **oracledb.user_commits** | Number of user commits. When a user commits a transaction, the redo generated that reflects the changes made to database blocks must be written to disk. Commits often represent the closest thing to a user transaction rate. | {commits} | Sum(Int) |
| -| **oracledb.user_rollbacks** | Number of times users manually issue the ROLLBACK statement or an error occurs during a user's transactions | 1 | Sum(Int) |
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: + +```yaml +metrics: + : + enabled: false +``` + +### oracledb.cpu_time + +Cumulative CPU time, in seconds + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Double | Cumulative | true | + +### oracledb.dml_locks.limit + +Maximum limit of active DML (Data Manipulation Language) locks. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {locks} | Gauge | Int | + +### oracledb.dml_locks.usage + +Current count of active DML (Data Manipulation Language) locks. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {locks} | Gauge | Int | + +### oracledb.enqueue_deadlocks + +Total number of deadlocks between table or row locks in different sessions. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {deadlocks} | Sum | Int | Cumulative | true | + +### oracledb.enqueue_locks.limit + +Maximum limit of active enqueue locks. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {locks} | Gauge | Int | + +### oracledb.enqueue_locks.usage + +Current count of active enqueue locks. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {locks} | Gauge | Int | + +### oracledb.enqueue_resources.limit + +Maximum limit of active enqueue resources. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {resources} | Gauge | Int | + +### oracledb.enqueue_resources.usage + +Current count of active enqueue resources. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {resources} | Gauge | Int | + +### oracledb.exchange_deadlocks + +Number of times that a process detected a potential deadlock when exchanging two buffers and raised an internal, restartable error. Index scans are the only operations that perform exchanges. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {deadlocks} | Sum | Int | Cumulative | true | + +### oracledb.executions + +Total number of calls (user and recursive) that executed SQL statements + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {executions} | Sum | Int | Cumulative | true | + +### oracledb.hard_parses + +Number of hard parses + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {parses} | Sum | Int | Cumulative | true | + +### oracledb.logical_reads + +Number of logical reads + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {reads} | Sum | Int | Cumulative | true | + +### oracledb.parse_calls + +Total number of parse calls. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {parses} | Sum | Int | Cumulative | true | + +### oracledb.pga_memory + +Session PGA (Program Global Area) memory + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +### oracledb.physical_reads + +Number of physical reads + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {reads} | Sum | Int | Cumulative | true | + +### oracledb.processes.limit + +Maximum limit of active processes. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {processes} | Gauge | Int | + +### oracledb.processes.usage + +Current count of active processes. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {processes} | Gauge | Int | + +### oracledb.sessions.limit + +Maximum limit of active sessions. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {sessions} | Gauge | Int | + +### oracledb.sessions.usage + +Count of active sessions. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {sessions} | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| session_type | Session type | Any Str | +| session_status | Session status | Any Str | + +### oracledb.tablespace_size.limit + +Maximum size of tablespace in bytes. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| tablespace_name | Tablespace name | Any Str | + +### oracledb.tablespace_size.usage + +Used tablespace in bytes. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| tablespace_name | Tablespace name | Any Str | + +### oracledb.transactions.limit + +Maximum limit of active transactions. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {transactions} | Gauge | Int | + +### oracledb.transactions.usage + +Current count of active transactions. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {transactions} | Gauge | Int | + +### oracledb.user_commits + +Number of user commits. When a user commits a transaction, the redo generated that reflects the changes made to database blocks must be written to disk. Commits often represent the closest thing to a user transaction rate. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {commits} | Sum | Int | Cumulative | true | + +### oracledb.user_rollbacks + +Number of times users manually issue the ROLLBACK statement or an error occurs during a user's transactions + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Resource attributes +### oracledb.cpu_time + +Cumulative CPU time, in seconds + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Double | Cumulative | true | + +### oracledb.dml_locks.limit + +Maximum limit of active DML (Data Manipulation Language) locks. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {locks} | Gauge | Int | + +### oracledb.dml_locks.usage + +Current count of active DML (Data Manipulation Language) locks. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {locks} | Gauge | Int | + +### oracledb.enqueue_deadlocks + +Total number of deadlocks between table or row locks in different sessions. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {deadlocks} | Sum | Int | Cumulative | true | + +### oracledb.enqueue_locks.limit + +Maximum limit of active enqueue locks. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {locks} | Gauge | Int | + +### oracledb.enqueue_locks.usage + +Current count of active enqueue locks. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {locks} | Gauge | Int | + +### oracledb.enqueue_resources.limit + +Maximum limit of active enqueue resources. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {resources} | Gauge | Int | + +### oracledb.enqueue_resources.usage + +Current count of active enqueue resources. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {resources} | Gauge | Int | + +### oracledb.exchange_deadlocks + +Number of times that a process detected a potential deadlock when exchanging two buffers and raised an internal, restartable error. Index scans are the only operations that perform exchanges. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {deadlocks} | Sum | Int | Cumulative | true | + +### oracledb.executions + +Total number of calls (user and recursive) that executed SQL statements + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {executions} | Sum | Int | Cumulative | true | + +### oracledb.hard_parses + +Number of hard parses + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {parses} | Sum | Int | Cumulative | true | + +### oracledb.logical_reads + +Number of logical reads + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {reads} | Sum | Int | Cumulative | true | + +### oracledb.parse_calls + +Total number of parse calls. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {parses} | Sum | Int | Cumulative | true | + +### oracledb.pga_memory + +Session PGA (Program Global Area) memory + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +### oracledb.physical_reads + +Number of physical reads + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {reads} | Sum | Int | Cumulative | true | + +### oracledb.processes.limit + +Maximum limit of active processes. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {processes} | Gauge | Int | + +### oracledb.processes.usage + +Current count of active processes. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {processes} | Gauge | Int | + +### oracledb.sessions.limit + +Maximum limit of active sessions. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {sessions} | Gauge | Int | + +### oracledb.sessions.usage + +Count of active sessions. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {sessions} | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| session_type | Session type | Any Str | +| session_status | Session status | Any Str | + +### oracledb.tablespace_size.limit + +Maximum size of tablespace in bytes. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| tablespace_name | Tablespace name | Any Str | + +### oracledb.tablespace_size.usage + +Used tablespace in bytes. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| tablespace_name | Tablespace name | Any Str | + +### oracledb.transactions.limit + +Maximum limit of active transactions. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {transactions} | Gauge | Int | + +### oracledb.transactions.usage + +Current count of active transactions. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {transactions} | Gauge | Int | + +### oracledb.user_commits + +Number of user commits. When a user commits a transaction, the redo generated that reflects the changes made to database blocks must be written to disk. Commits often represent the closest thing to a user transaction rate. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {commits} | Sum | Int | Cumulative | true | + +### oracledb.user_rollbacks + +Number of times users manually issue the ROLLBACK statement or an error occurs during a user's transactions -| Name | Description | Type | -| ---- | ----------- | ---- | -| oracledb.instance.name | The name of the instance that data is coming from. | Str | +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | -## Metric attributes +## Resource Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| session_status | Session status | | -| session_type | Session type | | -| tablespace_name | Tablespace name | | +| oracledb.instance.name | The name of the instance that data is coming from. | Any Str | diff --git a/receiver/postgresqlreceiver/documentation.md b/receiver/postgresqlreceiver/documentation.md index 5fe4ad127f2c..caf53c04f426 100644 --- a/receiver/postgresqlreceiver/documentation.md +++ b/receiver/postgresqlreceiver/documentation.md @@ -2,65 +2,552 @@ # postgresqlreceiver -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **postgresql.backends** | The number of backends. | 1 | Sum(Int) |
  • database
| -| **postgresql.bgwriter.buffers.allocated** | Number of buffers allocated. | {buffers} | Sum(Int) |
| -| **postgresql.bgwriter.buffers.writes** | Number of buffers written. | {buffers} | Sum(Int) |
  • bg_buffer_source
| -| **postgresql.bgwriter.checkpoint.count** | The number of checkpoints performed. | {checkpoints} | Sum(Int) |
  • bg_checkpoint_type
| -| **postgresql.bgwriter.duration** | Total time spent writing and syncing files to disk by checkpoints. | ms | Sum(Double) |
  • bg_duration_type
| -| **postgresql.bgwriter.maxwritten** | Number of times the background writer stopped a cleaning scan because it had written too many buffers. | | Sum(Int) |
| -| **postgresql.blocks_read** | The number of blocks read. | 1 | Sum(Int) |
  • database
  • table
  • source
| -| **postgresql.commits** | The number of commits. | 1 | Sum(Int) |
  • database
| -| **postgresql.connection.max** | Configured maximum number of client connections allowed | {connections} | Gauge(Int) |
| -| **postgresql.database.count** | Number of user databases. | {databases} | Sum(Int) |
| -| **postgresql.db_size** | The database disk usage. | By | Sum(Int) |
  • database
| -| **postgresql.index.scans** | The number of index scans on a table. | {scans} | Sum(Int) |
| -| **postgresql.index.size** | The size of the index on disk. | By | Gauge(Int) |
| -| **postgresql.operations** | The number of db row operations. | 1 | Sum(Int) |
  • database
  • table
  • operation
| -| **postgresql.replication.data_delay** | The amount of data delayed in replication. | By | Gauge(Int) |
  • replication_client
| -| **postgresql.rollbacks** | The number of rollbacks. | 1 | Sum(Int) |
  • database
| -| **postgresql.rows** | The number of rows in the database. | 1 | Sum(Int) |
  • database
  • table
  • state
| -| **postgresql.table.count** | Number of user tables in a database. | | Sum(Int) |
| -| **postgresql.table.size** | Disk space used by a table. | By | Sum(Int) |
| -| **postgresql.table.vacuum.count** | Number of times a table has manually been vacuumed. | {vacuums} | Sum(Int) |
| -| **postgresql.wal.age** | Age of the oldest WAL file. This metric requires WAL to be enabled with at least one replica. - | s | Gauge(Int) |
| -| **postgresql.wal.lag** | Time between flushing recent WAL locally and receiving notification that the standby server has completed an operation with it. This metric requires WAL to be enabled with at least one replica. - | s | Gauge(Int) |
  • wal_operation_lag
  • replication_client
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: + +```yaml +metrics: + : + enabled: false +``` + +### postgresql.backends + +The number of backends. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of the database. | Any Str | + +### postgresql.bgwriter.buffers.allocated + +Number of buffers allocated. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {buffers} | Sum | Int | Cumulative | true | + +### postgresql.bgwriter.buffers.writes + +Number of buffers written. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {buffers} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| source | The source of a buffer write. | Str: ``backend``, ``backend_fsync``, ``checkpoints``, ``bgwriter`` | + +### postgresql.bgwriter.checkpoint.count + +The number of checkpoints performed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {checkpoints} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | The type of checkpoint state. | Str: ``requested``, ``scheduled`` | + +### postgresql.bgwriter.duration + +Total time spent writing and syncing files to disk by checkpoints. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Double | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | The type of time spent during the checkpoint. | Str: ``sync``, ``write`` | + +### postgresql.bgwriter.maxwritten + +Number of times the background writer stopped a cleaning scan because it had written too many buffers. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | true | + +### postgresql.blocks_read + +The number of blocks read. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of the database. | Any Str | +| table | The schema name followed by the table name. | Any Str | +| source | The block read source type. | Str: ``heap_read``, ``heap_hit``, ``idx_read``, ``idx_hit``, ``toast_read``, ``toast_hit``, ``tidx_read``, ``tidx_hit`` | + +### postgresql.commits + +The number of commits. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of the database. | Any Str | + +### postgresql.connection.max + +Configured maximum number of client connections allowed + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {connections} | Gauge | Int | + +### postgresql.database.count + +Number of user databases. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {databases} | Sum | Int | Cumulative | false | + +### postgresql.db_size + +The database disk usage. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of the database. | Any Str | + +### postgresql.index.scans + +The number of index scans on a table. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {scans} | Sum | Int | Cumulative | true | + +### postgresql.index.size + +The size of the index on disk. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### postgresql.operations + +The number of db row operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of the database. | Any Str | +| table | The schema name followed by the table name. | Any Str | +| operation | The database operation. | Str: ``ins``, ``upd``, ``del``, ``hot_upd`` | + +### postgresql.replication.data_delay + +The amount of data delayed in replication. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| replication_client | The IP address of the client connected to this backend. If this field is "unix", it indicates either that the client is connected via a Unix socket. | Any Str | + +### postgresql.rollbacks + +The number of rollbacks. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of the database. | Any Str | + +### postgresql.rows + +The number of rows in the database. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of the database. | Any Str | +| table | The schema name followed by the table name. | Any Str | +| state | The tuple (row) state. | Str: ``dead``, ``live`` | + +### postgresql.table.count + +Number of user tables in a database. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | false | + +### postgresql.table.size + +Disk space used by a table. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### postgresql.table.vacuum.count + +Number of times a table has manually been vacuumed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {vacuums} | Sum | Int | Cumulative | true | + +### postgresql.wal.age + +Age of the oldest WAL file. + +This metric requires WAL to be enabled with at least one replica. + + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| s | Gauge | Int | + +### postgresql.wal.lag + +Time between flushing recent WAL locally and receiving notification that the standby server has completed an operation with it. + +This metric requires WAL to be enabled with at least one replica. + + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| s | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The operation which is responsible for the lag. | Str: ``flush``, ``replay``, ``write`` | +| replication_client | The IP address of the client connected to this backend. If this field is "unix", it indicates either that the client is connected via a Unix socket. | Any Str | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Resource attributes +### postgresql.backends + +The number of backends. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of the database. | Any Str | + +### postgresql.bgwriter.buffers.allocated + +Number of buffers allocated. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {buffers} | Sum | Int | Cumulative | true | + +### postgresql.bgwriter.buffers.writes + +Number of buffers written. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {buffers} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| source | The source of a buffer write. | Str: ``backend``, ``backend_fsync``, ``checkpoints``, ``bgwriter`` | + +### postgresql.bgwriter.checkpoint.count + +The number of checkpoints performed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {checkpoints} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | The type of checkpoint state. | Str: ``requested``, ``scheduled`` | + +### postgresql.bgwriter.duration + +Total time spent writing and syncing files to disk by checkpoints. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Double | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | The type of time spent during the checkpoint. | Str: ``sync``, ``write`` | + +### postgresql.bgwriter.maxwritten + +Number of times the background writer stopped a cleaning scan because it had written too many buffers. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | true | + +### postgresql.blocks_read + +The number of blocks read. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of the database. | Any Str | +| table | The schema name followed by the table name. | Any Str | +| source | The block read source type. | Str: ``heap_read``, ``heap_hit``, ``idx_read``, ``idx_hit``, ``toast_read``, ``toast_hit``, ``tidx_read``, ``tidx_hit`` | + +### postgresql.commits + +The number of commits. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of the database. | Any Str | + +### postgresql.connection.max + +Configured maximum number of client connections allowed + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {connections} | Gauge | Int | + +### postgresql.database.count + +Number of user databases. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {databases} | Sum | Int | Cumulative | false | + +### postgresql.db_size + +The database disk usage. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | -| Name | Description | Type | -| ---- | ----------- | ---- | -| postgresql.database.name | The name of the database. | Str | -| postgresql.index.name | The name of the index on a table. | Str | -| postgresql.table.name | The schema name followed by the table name. | Str | +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of the database. | Any Str | + +### postgresql.index.scans + +The number of index scans on a table. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {scans} | Sum | Int | Cumulative | true | + +### postgresql.index.size + +The size of the index on disk. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### postgresql.operations + +The number of db row operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of the database. | Any Str | +| table | The schema name followed by the table name. | Any Str | +| operation | The database operation. | Str: ``ins``, ``upd``, ``del``, ``hot_upd`` | + +### postgresql.replication.data_delay + +The amount of data delayed in replication. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| replication_client | The IP address of the client connected to this backend. If this field is "unix", it indicates either that the client is connected via a Unix socket. | Any Str | + +### postgresql.rollbacks + +The number of rollbacks. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of the database. | Any Str | + +### postgresql.rows + +The number of rows in the database. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| 1 | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| database | The name of the database. | Any Str | +| table | The schema name followed by the table name. | Any Str | +| state | The tuple (row) state. | Str: ``dead``, ``live`` | + +### postgresql.table.count + +Number of user tables in a database. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | false | + +### postgresql.table.size + +Disk space used by a table. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### postgresql.table.vacuum.count + +Number of times a table has manually been vacuumed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {vacuums} | Sum | Int | Cumulative | true | + +### postgresql.wal.age + +Age of the oldest WAL file. + +This metric requires WAL to be enabled with at least one replica. + + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| s | Gauge | Int | + +### postgresql.wal.lag + +Time between flushing recent WAL locally and receiving notification that the standby server has completed an operation with it. + +This metric requires WAL to be enabled with at least one replica. + + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| s | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The operation which is responsible for the lag. | Str: ``flush``, ``replay``, ``write`` | +| replication_client | The IP address of the client connected to this backend. If this field is "unix", it indicates either that the client is connected via a Unix socket. | Any Str | -## Metric attributes +## Resource Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| bg_buffer_source (source) | The source of a buffer write. | backend, backend_fsync, checkpoints, bgwriter | -| bg_checkpoint_type (type) | The type of checkpoint state. | requested, scheduled | -| bg_duration_type (type) | The type of time spent during the checkpoint. | sync, write | -| database | The name of the database. | | -| operation | The database operation. | ins, upd, del, hot_upd | -| replication_client | The IP address of the client connected to this backend. If this field is "unix", it indicates either that the client is connected via a Unix socket. | | -| source | The block read source type. | heap_read, heap_hit, idx_read, idx_hit, toast_read, toast_hit, tidx_read, tidx_hit | -| state | The tuple (row) state. | dead, live | -| table | The schema name followed by the table name. | | -| wal_operation_lag (operation) | The operation which is responsible for the lag. | flush, replay, write | +| postgresql.database.name | The name of the database. | Any Str | +| postgresql.index.name | The name of the index on a table. | Any Str | +| postgresql.table.name | The schema name followed by the table name. | Any Str | diff --git a/receiver/rabbitmqreceiver/documentation.md b/receiver/rabbitmqreceiver/documentation.md index 9329bd055355..748485f049c5 100644 --- a/receiver/rabbitmqreceiver/documentation.md +++ b/receiver/rabbitmqreceiver/documentation.md @@ -2,38 +2,138 @@ # rabbitmqreceiver -## Metrics +## Default Metrics -These are the metrics available for this scraper. +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **rabbitmq.consumer.count** | The number of consumers currently reading from the queue. | {consumers} | Sum(Int) |
| -| **rabbitmq.message.acknowledged** | The number of messages acknowledged by consumers. | {messages} | Sum(Int) |
| -| **rabbitmq.message.current** | The total number of messages currently in the queue. | {messages} | Sum(Int) |
  • message.state
| -| **rabbitmq.message.delivered** | The number of messages delivered to consumers. | {messages} | Sum(Int) |
| -| **rabbitmq.message.dropped** | The number of messages dropped as unroutable. | {messages} | Sum(Int) |
| -| **rabbitmq.message.published** | The number of messages published to a queue. | {messages} | Sum(Int) |
| +```yaml +metrics: + : + enabled: false +``` + +### rabbitmq.consumer.count + +The number of consumers currently reading from the queue. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {consumers} | Sum | Int | Cumulative | false | + +### rabbitmq.message.acknowledged + +The number of messages acknowledged by consumers. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {messages} | Sum | Int | Cumulative | true | + +### rabbitmq.message.current + +The total number of messages currently in the queue. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {messages} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | The state of messages in a queue. | Str: ``ready``, ``unacknowledged`` | + +### rabbitmq.message.delivered + +The number of messages delivered to consumers. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {messages} | Sum | Int | Cumulative | true | + +### rabbitmq.message.dropped + +The number of messages dropped as unroutable. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {messages} | Sum | Int | Cumulative | true | + +### rabbitmq.message.published -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +The number of messages published to a queue. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {messages} | Sum | Int | Cumulative | true | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Resource attributes +### rabbitmq.consumer.count + +The number of consumers currently reading from the queue. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {consumers} | Sum | Int | Cumulative | false | + +### rabbitmq.message.acknowledged + +The number of messages acknowledged by consumers. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {messages} | Sum | Int | Cumulative | true | + +### rabbitmq.message.current + +The total number of messages currently in the queue. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {messages} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | The state of messages in a queue. | Str: ``ready``, ``unacknowledged`` | + +### rabbitmq.message.delivered + +The number of messages delivered to consumers. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {messages} | Sum | Int | Cumulative | true | + +### rabbitmq.message.dropped + +The number of messages dropped as unroutable. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {messages} | Sum | Int | Cumulative | true | + +### rabbitmq.message.published + +The number of messages published to a queue. -| Name | Description | Type | -| ---- | ----------- | ---- | -| rabbitmq.node.name | The name of the RabbitMQ node. | Str | -| rabbitmq.queue.name | The name of the RabbitMQ queue. | Str | -| rabbitmq.vhost.name | The name of the RabbitMQ vHost. | Str | +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {messages} | Sum | Int | Cumulative | true | -## Metric attributes +## Resource Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| message.state (state) | The state of messages in a queue. | ready, unacknowledged | +| rabbitmq.node.name | The name of the RabbitMQ node. | Any Str | +| rabbitmq.queue.name | The name of the RabbitMQ queue. | Any Str | +| rabbitmq.vhost.name | The name of the RabbitMQ vHost. | Any Str | diff --git a/receiver/redisreceiver/documentation.md b/receiver/redisreceiver/documentation.md index 636165192a24..4832255a839b 100644 --- a/receiver/redisreceiver/documentation.md +++ b/receiver/redisreceiver/documentation.md @@ -2,66 +2,540 @@ # redisreceiver -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **redis.clients.blocked** | Number of clients pending on a blocking call | | Sum(Int) |
| -| **redis.clients.connected** | Number of client connections (excluding connections from replicas) | | Sum(Int) |
| -| **redis.clients.max_input_buffer** | Biggest input buffer among current client connections | | Gauge(Int) |
| -| **redis.clients.max_output_buffer** | Longest output list among current client connections | | Gauge(Int) |
| -| redis.cmd.calls | Total number of calls for a command | | Sum(Int) |
  • cmd
| -| redis.cmd.usec | Total time for all executions of this command | us | Sum(Int) |
  • cmd
| -| **redis.commands** | Number of commands processed per second | {ops}/s | Gauge(Int) |
| -| **redis.commands.processed** | Total number of commands processed by the server | | Sum(Int) |
| -| **redis.connections.received** | Total number of connections accepted by the server | | Sum(Int) |
| -| **redis.connections.rejected** | Number of connections rejected because of maxclients limit | | Sum(Int) |
| -| **redis.cpu.time** | System CPU consumed by the Redis server in seconds since server start | s | Sum(Double) |
  • state
| -| **redis.db.avg_ttl** | Average keyspace keys TTL | ms | Gauge(Int) |
  • db
| -| **redis.db.expires** | Number of keyspace keys with an expiration | | Gauge(Int) |
  • db
| -| **redis.db.keys** | Number of keyspace keys | | Gauge(Int) |
  • db
| -| **redis.keys.evicted** | Number of evicted keys due to maxmemory limit | | Sum(Int) |
| -| **redis.keys.expired** | Total number of key expiration events | | Sum(Int) |
| -| **redis.keyspace.hits** | Number of successful lookup of keys in the main dictionary | | Sum(Int) |
| -| **redis.keyspace.misses** | Number of failed lookup of keys in the main dictionary | | Sum(Int) |
| -| **redis.latest_fork** | Duration of the latest fork operation in microseconds | us | Gauge(Int) |
| -| redis.maxmemory | The value of the maxmemory configuration directive | By | Gauge(Int) |
| -| **redis.memory.fragmentation_ratio** | Ratio between used_memory_rss and used_memory | | Gauge(Double) |
| -| **redis.memory.lua** | Number of bytes used by the Lua engine | By | Gauge(Int) |
| -| **redis.memory.peak** | Peak memory consumed by Redis (in bytes) | By | Gauge(Int) |
| -| **redis.memory.rss** | Number of bytes that Redis allocated as seen by the operating system | By | Gauge(Int) |
| -| **redis.memory.used** | Total number of bytes allocated by Redis using its allocator | By | Gauge(Int) |
| -| **redis.net.input** | The total number of bytes read from the network | By | Sum(Int) |
| -| **redis.net.output** | The total number of bytes written to the network | By | Sum(Int) |
| -| **redis.rdb.changes_since_last_save** | Number of changes since the last dump | | Sum(Int) |
| -| **redis.replication.backlog_first_byte_offset** | The master offset of the replication backlog buffer | | Gauge(Int) |
| -| **redis.replication.offset** | The server's current replication offset | | Gauge(Int) |
| -| redis.role | Redis node's role | | Sum(Int) |
  • role
| -| **redis.slaves.connected** | Number of connected replicas | | Sum(Int) |
| -| **redis.uptime** | Number of seconds since Redis server start | s | Sum(Int) |
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: + +```yaml +metrics: + : + enabled: false +``` + +### redis.clients.blocked + +Number of clients pending on a blocking call + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | false | + +### redis.clients.connected + +Number of client connections (excluding connections from replicas) + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | false | + +### redis.clients.max_input_buffer + +Biggest input buffer among current client connections + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| | Gauge | Int | + +### redis.clients.max_output_buffer + +Longest output list among current client connections + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| | Gauge | Int | + +### redis.commands + +Number of commands processed per second + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {ops}/s | Gauge | Int | + +### redis.commands.processed + +Total number of commands processed by the server + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | true | + +### redis.connections.received + +Total number of connections accepted by the server + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | true | + +### redis.connections.rejected + +Number of connections rejected because of maxclients limit + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | true | + +### redis.cpu.time + +System CPU consumed by the Redis server in seconds since server start + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Double | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | Redis CPU usage state | Str: ``sys``, ``sys_children``, ``sys_main_thread``, ``user``, ``user_children``, ``user_main_thread`` | + +### redis.db.avg_ttl + +Average keyspace keys TTL + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| db | Redis database identifier | Any Str | + +### redis.db.expires + +Number of keyspace keys with an expiration + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| db | Redis database identifier | Any Str | + +### redis.db.keys + +Number of keyspace keys + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| db | Redis database identifier | Any Str | + +### redis.keys.evicted + +Number of evicted keys due to maxmemory limit + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | true | + +### redis.keys.expired + +Total number of key expiration events + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | true | + +### redis.keyspace.hits + +Number of successful lookup of keys in the main dictionary + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | true | + +### redis.keyspace.misses + +Number of failed lookup of keys in the main dictionary + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | true | + +### redis.latest_fork + +Duration of the latest fork operation in microseconds + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| us | Gauge | Int | + +### redis.memory.fragmentation_ratio + +Ratio between used_memory_rss and used_memory + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| | Gauge | Double | + +### redis.memory.lua + +Number of bytes used by the Lua engine + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### redis.memory.peak + +Peak memory consumed by Redis (in bytes) + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### redis.memory.rss + +Number of bytes that Redis allocated as seen by the operating system + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### redis.memory.used + +Total number of bytes allocated by Redis using its allocator + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### redis.net.input + +The total number of bytes read from the network + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +### redis.net.output + +The total number of bytes written to the network + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +### redis.rdb.changes_since_last_save + +Number of changes since the last dump + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | false | + +### redis.replication.backlog_first_byte_offset + +The master offset of the replication backlog buffer + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| | Gauge | Int | + +### redis.replication.offset + +The server's current replication offset + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| | Gauge | Int | + +### redis.slaves.connected + +Number of connected replicas + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | false | + +### redis.uptime + +Number of seconds since Redis server start + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Int | Cumulative | true | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Resource attributes +### redis.clients.blocked + +Number of clients pending on a blocking call + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | false | + +### redis.clients.connected + +Number of client connections (excluding connections from replicas) + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | false | + +### redis.clients.max_input_buffer + +Biggest input buffer among current client connections + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| | Gauge | Int | + +### redis.clients.max_output_buffer + +Longest output list among current client connections + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| | Gauge | Int | + +### redis.commands + +Number of commands processed per second + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {ops}/s | Gauge | Int | + +### redis.commands.processed + +Total number of commands processed by the server + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | true | + +### redis.connections.received + +Total number of connections accepted by the server + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | true | + +### redis.connections.rejected + +Number of connections rejected because of maxclients limit + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | true | + +### redis.cpu.time + +System CPU consumed by the Redis server in seconds since server start + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Double | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | Redis CPU usage state | Str: ``sys``, ``sys_children``, ``sys_main_thread``, ``user``, ``user_children``, ``user_main_thread`` | + +### redis.db.avg_ttl + +Average keyspace keys TTL + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| db | Redis database identifier | Any Str | + +### redis.db.expires + +Number of keyspace keys with an expiration + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| db | Redis database identifier | Any Str | + +### redis.db.keys + +Number of keyspace keys + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| db | Redis database identifier | Any Str | + +### redis.keys.evicted + +Number of evicted keys due to maxmemory limit + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | true | + +### redis.keys.expired + +Total number of key expiration events + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | true | + +### redis.keyspace.hits + +Number of successful lookup of keys in the main dictionary + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | true | + +### redis.keyspace.misses + +Number of failed lookup of keys in the main dictionary + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | true | + +### redis.latest_fork + +Duration of the latest fork operation in microseconds + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| us | Gauge | Int | + +### redis.memory.fragmentation_ratio + +Ratio between used_memory_rss and used_memory + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| | Gauge | Double | + +### redis.memory.lua + +Number of bytes used by the Lua engine + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### redis.memory.peak + +Peak memory consumed by Redis (in bytes) + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### redis.memory.rss + +Number of bytes that Redis allocated as seen by the operating system + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### redis.memory.used + +Total number of bytes allocated by Redis using its allocator + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By | Gauge | Int | + +### redis.net.input + +The total number of bytes read from the network + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +### redis.net.output + +The total number of bytes written to the network + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +### redis.rdb.changes_since_last_save + +Number of changes since the last dump + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | false | + +### redis.replication.backlog_first_byte_offset + +The master offset of the replication backlog buffer + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| | Gauge | Int | + +### redis.replication.offset + +The server's current replication offset + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| | Gauge | Int | + +### redis.slaves.connected + +Number of connected replicas + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| | Sum | Int | Cumulative | false | + +### redis.uptime + +Number of seconds since Redis server start -| Name | Description | Type | -| ---- | ----------- | ---- | -| redis.version | Redis server's version. | Str | +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Int | Cumulative | true | -## Metric attributes +## Resource Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| cmd | Redis command name | | -| db | Redis database identifier | | -| role | Redis node's role | replica, primary | -| state | Redis CPU usage state | sys, sys_children, sys_main_thread, user, user_children, user_main_thread | +| redis.version | Redis server's version. | Any Str | diff --git a/receiver/riakreceiver/documentation.md b/receiver/riakreceiver/documentation.md index 431cd64353fd..57a12f9d7a54 100644 --- a/receiver/riakreceiver/documentation.md +++ b/receiver/riakreceiver/documentation.md @@ -2,37 +2,172 @@ # riakreceiver -## Metrics +## Default Metrics -These are the metrics available for this scraper. +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **riak.memory.limit** | The amount of memory allocated to the node. | By | Sum(Int) |
| -| **riak.node.operation.count** | The number of operations performed by the node. | {operation} | Sum(Int) |
  • request
| -| **riak.node.operation.time.mean** | The mean time between request and response for operations performed by the node over the last minute. | us | Gauge(Int) |
  • request
| -| **riak.node.read_repair.count** | The number of read repairs performed by the node. | {read_repair} | Sum(Int) |
| -| **riak.vnode.index.operation.count** | The number of index operations performed by vnodes on the node. | {operation} | Sum(Int) |
  • operation
| -| **riak.vnode.operation.count** | The number of operations performed by vnodes on the node. | {operation} | Sum(Int) |
  • request
| +```yaml +metrics: + : + enabled: false +``` + +### riak.memory.limit + +The amount of memory allocated to the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### riak.node.operation.count + +The number of operations performed by the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operation} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| request | The request operation type. | Str: ``put``, ``get`` | + +### riak.node.operation.time.mean + +The mean time between request and response for operations performed by the node over the last minute. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| us | Gauge | Int | + +#### Attributes -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +| Name | Description | Values | +| ---- | ----------- | ------ | +| request | The request operation type. | Str: ``put``, ``get`` | + +### riak.node.read_repair.count + +The number of read repairs performed by the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {read_repair} | Sum | Int | Cumulative | true | + +### riak.vnode.index.operation.count + +The number of index operations performed by vnodes on the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operation} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The operation type for index operations. | Str: ``read``, ``write``, ``delete`` | + +### riak.vnode.operation.count + +The number of operations performed by vnodes on the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operation} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| request | The request operation type. | Str: ``put``, ``get`` | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Resource attributes +### riak.memory.limit + +The amount of memory allocated to the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### riak.node.operation.count + +The number of operations performed by the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operation} | Sum | Int | Cumulative | true | + +#### Attributes -| Name | Description | Type | -| ---- | ----------- | ---- | -| riak.node.name | The name this node uses to identify itself. | Str | +| Name | Description | Values | +| ---- | ----------- | ------ | +| request | The request operation type. | Str: ``put``, ``get`` | + +### riak.node.operation.time.mean + +The mean time between request and response for operations performed by the node over the last minute. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| us | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| request | The request operation type. | Str: ``put``, ``get`` | + +### riak.node.read_repair.count + +The number of read repairs performed by the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {read_repair} | Sum | Int | Cumulative | true | + +### riak.vnode.index.operation.count + +The number of index operations performed by vnodes on the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operation} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| operation | The operation type for index operations. | Str: ``read``, ``write``, ``delete`` | + +### riak.vnode.operation.count + +The number of operations performed by vnodes on the node. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operation} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| request | The request operation type. | Str: ``put``, ``get`` | -## Metric attributes +## Resource Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| operation | The operation type for index operations. | read, write, delete | -| request | The request operation type. | put, get | +| riak.node.name | The name this node uses to identify itself. | Any Str | diff --git a/receiver/saphanareceiver/documentation.md b/receiver/saphanareceiver/documentation.md index fb35e4c78645..d36d0250f9cb 100644 --- a/receiver/saphanareceiver/documentation.md +++ b/receiver/saphanareceiver/documentation.md @@ -2,106 +2,1273 @@ # saphanareceiver -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **saphana.alert.count** | Number of current alerts. | {alerts} | Sum(Int) |
  • alert_rating
| -| **saphana.backup.latest** | The age of the latest backup by start time. | s | Gauge(Int) |
| -| **saphana.column.memory.used** | The memory used in all columns. | By | Sum(Int) |
  • column_memory_type
  • column_memory_subtype
| -| **saphana.component.memory.used** | The memory used in components. | By | Sum(Int) |
  • component
| -| **saphana.connection.count** | The number of current connections. | {connections} | Sum(Int) |
  • connection_status
| -| **saphana.cpu.used** | Total CPU time spent. | ms | Sum(Int) |
  • cpu_type
| -| **saphana.disk.size.current** | The disk size. | By | Sum(Int) |
  • path
  • disk_usage_type
  • disk_state_used_free
| -| **saphana.host.memory.current** | The amount of physical memory on the host. | By | Sum(Int) |
  • memory_state_used_free
| -| **saphana.host.swap.current** | The amount of swap space on the host. | By | Sum(Int) |
  • host_swap_state
| -| **saphana.instance.code_size** | The instance code size, including shared libraries of SAP HANA processes. | By | Sum(Int) |
| -| **saphana.instance.memory.current** | The size of the memory pool for all SAP HANA processes. | By | Sum(Int) |
  • memory_state_used_free
| -| **saphana.instance.memory.shared.allocated** | The shared memory size of SAP HANA processes. | By | Sum(Int) |
| -| **saphana.instance.memory.used.peak** | The peak memory from the memory pool used by SAP HANA processes since the instance started (this is a sample-based value). | By | Sum(Int) |
| -| **saphana.license.expiration.time** | The amount of time remaining before license expiration. | s | Gauge(Int) |
  • system
  • product
| -| **saphana.license.limit** | The allowed product usage as specified by the license (for example, main memory). | {licenses} | Sum(Int) |
  • system
  • product
| -| **saphana.license.peak** | The peak product usage value during last 13 months, measured periodically. | {licenses} | Sum(Int) |
  • system
  • product
| -| **saphana.network.request.average_time** | The average response time calculated over recent requests | ms | Gauge(Double) |
| -| **saphana.network.request.count** | The number of active and pending service requests. | {requests} | Sum(Int) |
  • active_pending_request_state
| -| **saphana.network.request.finished.count** | The number of service requests that have completed. | {requests} | Sum(Int) |
  • internal_external_request_type
| -| **saphana.replication.average_time** | The average amount of time consumed replicating a log. | us | Gauge(Double) |
  • primary_host
  • secondary_host
  • port
  • replication_mode
| -| **saphana.replication.backlog.size** | The current replication backlog size. | By | Sum(Int) |
  • primary_host
  • secondary_host
  • port
  • replication_mode
| -| **saphana.replication.backlog.time** | The current replication backlog. | us | Sum(Int) |
  • primary_host
  • secondary_host
  • port
  • replication_mode
| -| **saphana.row_store.memory.used** | The used memory for all row tables. | By | Sum(Int) |
  • row_memory_type
| -| **saphana.schema.memory.used.current** | The memory size for all tables in schema. | By | Sum(Int) |
  • schema
  • schema_memory_type
| -| **saphana.schema.memory.used.max** | The estimated maximum memory consumption for all fully loaded tables in schema (data for open transactions is not included). | By | Sum(Int) |
  • schema
| -| **saphana.schema.operation.count** | The number of operations done on all tables in schema. | {operations} | Sum(Int) |
  • schema
  • schema_operation_type
| -| **saphana.schema.record.compressed.count** | The number of entries in main during the last optimize compression run for all tables in schema. | {records} | Sum(Int) |
  • schema
| -| **saphana.schema.record.count** | The number of records for all tables in schema. | {records} | Sum(Int) |
  • schema
  • schema_record_type
| -| **saphana.service.code_size** | The service code size, including shared libraries. | By | Sum(Int) |
  • service
| -| **saphana.service.count** | The number of services in a given status. | {services} | Sum(Int) |
  • service_status
| -| **saphana.service.memory.compactors.allocated** | The part of the memory pool that can potentially (if unpinned) be freed during a memory shortage. | By | Sum(Int) |
  • service
| -| **saphana.service.memory.compactors.freeable** | The memory that can be freed during a memory shortage. | By | Sum(Int) |
  • service
| -| **saphana.service.memory.effective_limit** | The effective maximum memory pool size, calculated considering the pool sizes of other processes. | By | Sum(Int) |
  • service
| -| **saphana.service.memory.heap.current** | The size of the heap portion of the memory pool. | By | Sum(Int) |
  • service
  • memory_state_used_free
| -| **saphana.service.memory.limit** | The configured maximum memory pool size. | By | Sum(Int) |
  • service
| -| **saphana.service.memory.shared.current** | The size of the shared portion of the memory pool. | By | Sum(Int) |
  • service
  • memory_state_used_free
| -| **saphana.service.memory.used** | The used memory from the operating system perspective. | By | Sum(Int) |
  • service
  • service_memory_used_type
| -| **saphana.service.stack_size** | The service stack size. | By | Sum(Int) |
  • service
| -| **saphana.service.thread.count** | The number of service threads in a given status. | {threads} | Sum(Int) |
  • thread_status
| -| **saphana.transaction.blocked** | The number of transactions waiting for a lock. | {transactions} | Sum(Int) |
| -| **saphana.transaction.count** | The number of transactions. | {transactions} | Sum(Int) |
  • transaction_type
| -| **saphana.uptime** | The uptime of the database. | s | Sum(Int) |
  • system
  • database
| -| **saphana.volume.operation.count** | The number of operations executed. | {operations} | Sum(Int) |
  • path
  • disk_usage_type
  • volume_operation_type
| -| **saphana.volume.operation.size** | The size of operations executed. | By | Sum(Int) |
  • path
  • disk_usage_type
  • volume_operation_type
| -| **saphana.volume.operation.time** | The time spent executing operations. | ms | Sum(Int) |
  • path
  • disk_usage_type
  • volume_operation_type
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: false ``` -## Resource attributes - -| Name | Description | Type | -| ---- | ----------- | ---- | -| db.system | The type of database system. | Str | -| saphana.host | The SAP HANA host. | Str | - -## Metric attributes - -| Name | Description | Values | -| ---- | ----------- | ------ | -| active_pending_request_state (state) | The state of network request. | active, pending | -| alert_rating (rating) | The alert rating. | | -| column_memory_subtype (subtype) | The subtype of column store memory. | data, dict, index, misc | -| column_memory_type (type) | The type of column store memory. | main, delta | -| component | The SAP HANA component. | | -| connection_status (status) | The connection status. | running, idle, queueing | -| cpu_type (type) | The type of cpu. | user, system, io_wait, idle | -| database | The SAP HANA database. | | -| disk_state_used_free (state) | The state of the disk storage. | used, free | -| disk_usage_type (usage_type) | The SAP HANA disk & volume usage type. | | -| host_swap_state (state) | The state of swap data. | used, free | -| internal_external_request_type (type) | The type of network request. | internal, external | -| memory_state_used_free (state) | The state of memory. | used, free | -| path | The SAP HANA disk path. | | -| port | The SAP HANA port. | | -| primary_host (primary) | The primary SAP HANA host in replication. | | -| product | The SAP HANA product. | | -| replication_mode (mode) | The replication mode. | | -| row_memory_type (type) | The type of row store memory. | fixed, variable | -| schema | The SAP HANA schema. | | -| schema_memory_type (type) | The type of schema memory. | main, delta, history_main, history_delta | -| schema_operation_type (type) | The type of operation. | read, write, merge | -| schema_record_type (type) | The type of schema record. | main, delta, history_main, history_delta | -| secondary_host (secondary) | The secondary SAP HANA host in replication. | | -| service | The SAP HANA service. | | -| service_memory_used_type (type) | The type of service memory. | logical, physical | -| service_status (status) | The status of services. | active, inactive | -| system | The SAP HANA system. | | -| thread_status (status) | The status of threads. | active, inactive | -| transaction_type (type) | The transaction type. | update, commit, rollback | -| volume_operation_type (type) | The type of operation. | read, write | +### saphana.alert.count + +Number of current alerts. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {alerts} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| rating | The alert rating. | Any Str | + +### saphana.backup.latest + +The age of the latest backup by start time. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| s | Gauge | Int | + +### saphana.column.memory.used + +The memory used in all columns. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | The type of column store memory. | Str: ``main``, ``delta`` | +| subtype | The subtype of column store memory. | Str: ``data``, ``dict``, ``index``, ``misc`` | + +### saphana.component.memory.used + +The memory used in components. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| component | The SAP HANA component. | Any Str | + +### saphana.connection.count + +The number of current connections. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The connection status. | Str: ``running``, ``idle``, ``queueing`` | + +### saphana.cpu.used + +Total CPU time spent. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | The type of cpu. | Str: ``user``, ``system``, ``io_wait``, ``idle`` | + +### saphana.disk.size.current + +The disk size. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| path | The SAP HANA disk path. | Any Str | +| usage_type | The SAP HANA disk & volume usage type. | Any Str | +| state | The state of the disk storage. | Str: ``used``, ``free`` | + +### saphana.host.memory.current + +The amount of physical memory on the host. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | The state of memory. | Str: ``used``, ``free`` | + +### saphana.host.swap.current + +The amount of swap space on the host. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | The state of swap data. | Str: ``used``, ``free`` | + +### saphana.instance.code_size + +The instance code size, including shared libraries of SAP HANA processes. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### saphana.instance.memory.current + +The size of the memory pool for all SAP HANA processes. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | The state of memory. | Str: ``used``, ``free`` | + +### saphana.instance.memory.shared.allocated + +The shared memory size of SAP HANA processes. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### saphana.instance.memory.used.peak + +The peak memory from the memory pool used by SAP HANA processes since the instance started (this is a sample-based value). + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### saphana.license.expiration.time + +The amount of time remaining before license expiration. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| s | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| system | The SAP HANA system. | Any Str | +| product | The SAP HANA product. | Any Str | + +### saphana.license.limit + +The allowed product usage as specified by the license (for example, main memory). + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {licenses} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| system | The SAP HANA system. | Any Str | +| product | The SAP HANA product. | Any Str | + +### saphana.license.peak + +The peak product usage value during last 13 months, measured periodically. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {licenses} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| system | The SAP HANA system. | Any Str | +| product | The SAP HANA product. | Any Str | + +### saphana.network.request.average_time + +The average response time calculated over recent requests + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Double | + +### saphana.network.request.count + +The number of active and pending service requests. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | The state of network request. | Str: ``active``, ``pending`` | + +### saphana.network.request.finished.count + +The number of service requests that have completed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | The type of network request. | Str: ``internal``, ``external`` | + +### saphana.replication.average_time + +The average amount of time consumed replicating a log. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| us | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| primary | The primary SAP HANA host in replication. | Any Str | +| secondary | The secondary SAP HANA host in replication. | Any Str | +| port | The SAP HANA port. | Any Str | +| mode | The replication mode. | Any Str | + +### saphana.replication.backlog.size + +The current replication backlog size. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| primary | The primary SAP HANA host in replication. | Any Str | +| secondary | The secondary SAP HANA host in replication. | Any Str | +| port | The SAP HANA port. | Any Str | +| mode | The replication mode. | Any Str | + +### saphana.replication.backlog.time + +The current replication backlog. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| us | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| primary | The primary SAP HANA host in replication. | Any Str | +| secondary | The secondary SAP HANA host in replication. | Any Str | +| port | The SAP HANA port. | Any Str | +| mode | The replication mode. | Any Str | + +### saphana.row_store.memory.used + +The used memory for all row tables. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | The type of row store memory. | Str: ``fixed``, ``variable`` | + +### saphana.schema.memory.used.current + +The memory size for all tables in schema. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| schema | The SAP HANA schema. | Any Str | +| type | The type of schema memory. | Str: ``main``, ``delta``, ``history_main``, ``history_delta`` | + +### saphana.schema.memory.used.max + +The estimated maximum memory consumption for all fully loaded tables in schema (data for open transactions is not included). + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| schema | The SAP HANA schema. | Any Str | + +### saphana.schema.operation.count + +The number of operations done on all tables in schema. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| schema | The SAP HANA schema. | Any Str | +| type | The type of operation. | Str: ``read``, ``write``, ``merge`` | + +### saphana.schema.record.compressed.count + +The number of entries in main during the last optimize compression run for all tables in schema. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {records} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| schema | The SAP HANA schema. | Any Str | + +### saphana.schema.record.count + +The number of records for all tables in schema. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {records} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| schema | The SAP HANA schema. | Any Str | +| type | The type of schema record. | Str: ``main``, ``delta``, ``history_main``, ``history_delta`` | + +### saphana.service.code_size + +The service code size, including shared libraries. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| service | The SAP HANA service. | Any Str | + +### saphana.service.count + +The number of services in a given status. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {services} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The status of services. | Str: ``active``, ``inactive`` | + +### saphana.service.memory.compactors.allocated + +The part of the memory pool that can potentially (if unpinned) be freed during a memory shortage. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| service | The SAP HANA service. | Any Str | + +### saphana.service.memory.compactors.freeable + +The memory that can be freed during a memory shortage. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| service | The SAP HANA service. | Any Str | + +### saphana.service.memory.effective_limit + +The effective maximum memory pool size, calculated considering the pool sizes of other processes. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| service | The SAP HANA service. | Any Str | + +### saphana.service.memory.heap.current + +The size of the heap portion of the memory pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| service | The SAP HANA service. | Any Str | +| state | The state of memory. | Str: ``used``, ``free`` | + +### saphana.service.memory.limit + +The configured maximum memory pool size. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| service | The SAP HANA service. | Any Str | + +### saphana.service.memory.shared.current + +The size of the shared portion of the memory pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| service | The SAP HANA service. | Any Str | +| state | The state of memory. | Str: ``used``, ``free`` | + +### saphana.service.memory.used + +The used memory from the operating system perspective. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| service | The SAP HANA service. | Any Str | +| type | The type of service memory. | Str: ``logical``, ``physical`` | + +### saphana.service.stack_size + +The service stack size. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| service | The SAP HANA service. | Any Str | + +### saphana.service.thread.count + +The number of service threads in a given status. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {threads} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The status of threads. | Str: ``active``, ``inactive`` | + +### saphana.transaction.blocked + +The number of transactions waiting for a lock. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {transactions} | Sum | Int | Cumulative | false | + +### saphana.transaction.count + +The number of transactions. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {transactions} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | The transaction type. | Str: ``update``, ``commit``, ``rollback`` | + +### saphana.uptime + +The uptime of the database. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| system | The SAP HANA system. | Any Str | +| database | The SAP HANA database. | Any Str | + +### saphana.volume.operation.count + +The number of operations executed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| path | The SAP HANA disk path. | Any Str | +| usage_type | The SAP HANA disk & volume usage type. | Any Str | +| type | The type of operation. | Str: ``read``, ``write`` | + +### saphana.volume.operation.size + +The size of operations executed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| path | The SAP HANA disk path. | Any Str | +| usage_type | The SAP HANA disk & volume usage type. | Any Str | +| type | The type of operation. | Str: ``read``, ``write`` | + +### saphana.volume.operation.time + +The time spent executing operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| path | The SAP HANA disk path. | Any Str | +| usage_type | The SAP HANA disk & volume usage type. | Any Str | +| type | The type of operation. | Str: ``read``, ``write`` | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: + +```yaml +metrics: + : + enabled: true +``` + +### saphana.alert.count + +Number of current alerts. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {alerts} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| rating | The alert rating. | Any Str | + +### saphana.backup.latest + +The age of the latest backup by start time. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| s | Gauge | Int | + +### saphana.column.memory.used + +The memory used in all columns. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | The type of column store memory. | Str: ``main``, ``delta`` | +| subtype | The subtype of column store memory. | Str: ``data``, ``dict``, ``index``, ``misc`` | + +### saphana.component.memory.used + +The memory used in components. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| component | The SAP HANA component. | Any Str | + +### saphana.connection.count + +The number of current connections. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The connection status. | Str: ``running``, ``idle``, ``queueing`` | + +### saphana.cpu.used + +Total CPU time spent. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | The type of cpu. | Str: ``user``, ``system``, ``io_wait``, ``idle`` | + +### saphana.disk.size.current + +The disk size. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| path | The SAP HANA disk path. | Any Str | +| usage_type | The SAP HANA disk & volume usage type. | Any Str | +| state | The state of the disk storage. | Str: ``used``, ``free`` | + +### saphana.host.memory.current + +The amount of physical memory on the host. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | The state of memory. | Str: ``used``, ``free`` | + +### saphana.host.swap.current + +The amount of swap space on the host. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | The state of swap data. | Str: ``used``, ``free`` | + +### saphana.instance.code_size + +The instance code size, including shared libraries of SAP HANA processes. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### saphana.instance.memory.current + +The size of the memory pool for all SAP HANA processes. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | The state of memory. | Str: ``used``, ``free`` | + +### saphana.instance.memory.shared.allocated + +The shared memory size of SAP HANA processes. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### saphana.instance.memory.used.peak + +The peak memory from the memory pool used by SAP HANA processes since the instance started (this is a sample-based value). + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### saphana.license.expiration.time + +The amount of time remaining before license expiration. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| s | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| system | The SAP HANA system. | Any Str | +| product | The SAP HANA product. | Any Str | + +### saphana.license.limit + +The allowed product usage as specified by the license (for example, main memory). + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {licenses} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| system | The SAP HANA system. | Any Str | +| product | The SAP HANA product. | Any Str | + +### saphana.license.peak + +The peak product usage value during last 13 months, measured periodically. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {licenses} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| system | The SAP HANA system. | Any Str | +| product | The SAP HANA product. | Any Str | + +### saphana.network.request.average_time + +The average response time calculated over recent requests + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Double | + +### saphana.network.request.count + +The number of active and pending service requests. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | The state of network request. | Str: ``active``, ``pending`` | + +### saphana.network.request.finished.count + +The number of service requests that have completed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | The type of network request. | Str: ``internal``, ``external`` | + +### saphana.replication.average_time + +The average amount of time consumed replicating a log. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| us | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| primary | The primary SAP HANA host in replication. | Any Str | +| secondary | The secondary SAP HANA host in replication. | Any Str | +| port | The SAP HANA port. | Any Str | +| mode | The replication mode. | Any Str | + +### saphana.replication.backlog.size + +The current replication backlog size. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| primary | The primary SAP HANA host in replication. | Any Str | +| secondary | The secondary SAP HANA host in replication. | Any Str | +| port | The SAP HANA port. | Any Str | +| mode | The replication mode. | Any Str | + +### saphana.replication.backlog.time + +The current replication backlog. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| us | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| primary | The primary SAP HANA host in replication. | Any Str | +| secondary | The secondary SAP HANA host in replication. | Any Str | +| port | The SAP HANA port. | Any Str | +| mode | The replication mode. | Any Str | + +### saphana.row_store.memory.used + +The used memory for all row tables. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | The type of row store memory. | Str: ``fixed``, ``variable`` | + +### saphana.schema.memory.used.current + +The memory size for all tables in schema. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| schema | The SAP HANA schema. | Any Str | +| type | The type of schema memory. | Str: ``main``, ``delta``, ``history_main``, ``history_delta`` | + +### saphana.schema.memory.used.max + +The estimated maximum memory consumption for all fully loaded tables in schema (data for open transactions is not included). + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| schema | The SAP HANA schema. | Any Str | + +### saphana.schema.operation.count + +The number of operations done on all tables in schema. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| schema | The SAP HANA schema. | Any Str | +| type | The type of operation. | Str: ``read``, ``write``, ``merge`` | + +### saphana.schema.record.compressed.count + +The number of entries in main during the last optimize compression run for all tables in schema. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {records} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| schema | The SAP HANA schema. | Any Str | + +### saphana.schema.record.count + +The number of records for all tables in schema. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {records} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| schema | The SAP HANA schema. | Any Str | +| type | The type of schema record. | Str: ``main``, ``delta``, ``history_main``, ``history_delta`` | + +### saphana.service.code_size + +The service code size, including shared libraries. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| service | The SAP HANA service. | Any Str | + +### saphana.service.count + +The number of services in a given status. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {services} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The status of services. | Str: ``active``, ``inactive`` | + +### saphana.service.memory.compactors.allocated + +The part of the memory pool that can potentially (if unpinned) be freed during a memory shortage. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| service | The SAP HANA service. | Any Str | + +### saphana.service.memory.compactors.freeable + +The memory that can be freed during a memory shortage. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| service | The SAP HANA service. | Any Str | + +### saphana.service.memory.effective_limit + +The effective maximum memory pool size, calculated considering the pool sizes of other processes. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| service | The SAP HANA service. | Any Str | + +### saphana.service.memory.heap.current + +The size of the heap portion of the memory pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| service | The SAP HANA service. | Any Str | +| state | The state of memory. | Str: ``used``, ``free`` | + +### saphana.service.memory.limit + +The configured maximum memory pool size. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| service | The SAP HANA service. | Any Str | + +### saphana.service.memory.shared.current + +The size of the shared portion of the memory pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| service | The SAP HANA service. | Any Str | +| state | The state of memory. | Str: ``used``, ``free`` | + +### saphana.service.memory.used + +The used memory from the operating system perspective. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| service | The SAP HANA service. | Any Str | +| type | The type of service memory. | Str: ``logical``, ``physical`` | + +### saphana.service.stack_size + +The service stack size. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| service | The SAP HANA service. | Any Str | + +### saphana.service.thread.count + +The number of service threads in a given status. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {threads} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| status | The status of threads. | Str: ``active``, ``inactive`` | + +### saphana.transaction.blocked + +The number of transactions waiting for a lock. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {transactions} | Sum | Int | Cumulative | false | + +### saphana.transaction.count + +The number of transactions. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {transactions} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | The transaction type. | Str: ``update``, ``commit``, ``rollback`` | + +### saphana.uptime + +The uptime of the database. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| s | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| system | The SAP HANA system. | Any Str | +| database | The SAP HANA database. | Any Str | + +### saphana.volume.operation.count + +The number of operations executed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {operations} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| path | The SAP HANA disk path. | Any Str | +| usage_type | The SAP HANA disk & volume usage type. | Any Str | +| type | The type of operation. | Str: ``read``, ``write`` | + +### saphana.volume.operation.size + +The size of operations executed. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| path | The SAP HANA disk path. | Any Str | +| usage_type | The SAP HANA disk & volume usage type. | Any Str | +| type | The type of operation. | Str: ``read``, ``write`` | + +### saphana.volume.operation.time + +The time spent executing operations. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| ms | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| path | The SAP HANA disk path. | Any Str | +| usage_type | The SAP HANA disk & volume usage type. | Any Str | +| type | The type of operation. | Str: ``read``, ``write`` | + +## Resource Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| db.system | The type of database system. | Any Str | +| saphana.host | The SAP HANA host. | Any Str | diff --git a/receiver/sqlserverreceiver/documentation.md b/receiver/sqlserverreceiver/documentation.md index dbff39beb814..6313bf03516c 100644 --- a/receiver/sqlserverreceiver/documentation.md +++ b/receiver/sqlserverreceiver/documentation.md @@ -2,50 +2,360 @@ # sqlserverreceiver -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **sqlserver.batch.request.rate** | Number of batch requests received by SQL Server. | {requests}/s | Gauge(Double) |
| -| **sqlserver.batch.sql_compilation.rate** | Number of SQL compilations needed. | {compilations}/s | Gauge(Double) |
| -| **sqlserver.batch.sql_recompilation.rate** | Number of SQL recompilations needed. | {compilations}/s | Gauge(Double) |
| -| **sqlserver.lock.wait.rate** | Number of lock requests resulting in a wait. | {requests}/s | Gauge(Double) |
| -| **sqlserver.lock.wait_time.avg** | Average wait time for all lock requests that had to wait. | ms | Gauge(Double) |
| -| **sqlserver.page.buffer_cache.hit_ratio** | Pages found in the buffer pool without having to read from disk. | % | Gauge(Double) |
| -| **sqlserver.page.checkpoint.flush.rate** | Number of pages flushed by operations requiring dirty pages to be flushed. | {pages}/s | Gauge(Double) |
| -| **sqlserver.page.lazy_write.rate** | Number of lazy writes moving dirty pages to disk. | {writes}/s | Gauge(Double) |
| -| **sqlserver.page.life_expectancy** | Time a page will stay in the buffer pool. | s | Gauge(Int) |
| -| **sqlserver.page.operation.rate** | Number of physical database page operations issued. | {operations}/s | Gauge(Double) |
  • page.operations
| -| **sqlserver.page.split.rate** | Number of pages split as a result of overflowing index pages. | {pages}/s | Gauge(Double) |
| -| **sqlserver.transaction.rate** | Number of transactions started for the database (not including XTP-only transactions). | {transactions}/s | Gauge(Double) |
| -| **sqlserver.transaction.write.rate** | Number of transactions that wrote to the database and committed. | {transactions}/s | Gauge(Double) |
| -| **sqlserver.transaction_log.flush.data.rate** | Total number of log bytes flushed. | By/s | Gauge(Double) |
| -| **sqlserver.transaction_log.flush.rate** | Number of log flushes. | {flushes}/s | Gauge(Double) |
| -| **sqlserver.transaction_log.flush.wait.rate** | Number of commits waiting for a transaction log flush. | {commits}/s | Gauge(Double) |
| -| **sqlserver.transaction_log.growth.count** | Total number of transaction log expansions for a database. | {growths} | Sum(Int) |
| -| **sqlserver.transaction_log.shrink.count** | Total number of transaction log shrinks for a database. | {shrinks} | Sum(Int) |
| -| **sqlserver.transaction_log.usage** | Percent of transaction log space used. | % | Gauge(Int) |
| -| **sqlserver.user.connection.count** | Number of users connected to the SQL Server. | {connections} | Gauge(Int) |
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: + +```yaml +metrics: + : + enabled: false +``` + +### sqlserver.batch.request.rate + +Number of batch requests received by SQL Server. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {requests}/s | Gauge | Double | + +### sqlserver.batch.sql_compilation.rate + +Number of SQL compilations needed. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {compilations}/s | Gauge | Double | + +### sqlserver.batch.sql_recompilation.rate + +Number of SQL recompilations needed. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {compilations}/s | Gauge | Double | + +### sqlserver.lock.wait.rate + +Number of lock requests resulting in a wait. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {requests}/s | Gauge | Double | + +### sqlserver.lock.wait_time.avg + +Average wait time for all lock requests that had to wait. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Double | + +### sqlserver.page.buffer_cache.hit_ratio + +Pages found in the buffer pool without having to read from disk. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +### sqlserver.page.checkpoint.flush.rate + +Number of pages flushed by operations requiring dirty pages to be flushed. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {pages}/s | Gauge | Double | + +### sqlserver.page.lazy_write.rate + +Number of lazy writes moving dirty pages to disk. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {writes}/s | Gauge | Double | + +### sqlserver.page.life_expectancy + +Time a page will stay in the buffer pool. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| s | Gauge | Int | + +### sqlserver.page.operation.rate + +Number of physical database page operations issued. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {operations}/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | The page operation types. | Str: ``read``, ``write`` | + +### sqlserver.page.split.rate + +Number of pages split as a result of overflowing index pages. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {pages}/s | Gauge | Double | + +### sqlserver.transaction.rate + +Number of transactions started for the database (not including XTP-only transactions). + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {transactions}/s | Gauge | Double | + +### sqlserver.transaction.write.rate + +Number of transactions that wrote to the database and committed. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {transactions}/s | Gauge | Double | + +### sqlserver.transaction_log.flush.data.rate + +Total number of log bytes flushed. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By/s | Gauge | Double | + +### sqlserver.transaction_log.flush.rate + +Number of log flushes. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {flushes}/s | Gauge | Double | + +### sqlserver.transaction_log.flush.wait.rate + +Number of commits waiting for a transaction log flush. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {commits}/s | Gauge | Double | + +### sqlserver.transaction_log.growth.count + +Total number of transaction log expansions for a database. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {growths} | Sum | Int | Cumulative | true | + +### sqlserver.transaction_log.shrink.count + +Total number of transaction log shrinks for a database. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {shrinks} | Sum | Int | Cumulative | true | + +### sqlserver.transaction_log.usage + +Percent of transaction log space used. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Int | + +### sqlserver.user.connection.count + +Number of users connected to the SQL Server. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {connections} | Gauge | Int | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Resource attributes +### sqlserver.batch.request.rate + +Number of batch requests received by SQL Server. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {requests}/s | Gauge | Double | + +### sqlserver.batch.sql_compilation.rate + +Number of SQL compilations needed. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {compilations}/s | Gauge | Double | + +### sqlserver.batch.sql_recompilation.rate + +Number of SQL recompilations needed. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {compilations}/s | Gauge | Double | + +### sqlserver.lock.wait.rate + +Number of lock requests resulting in a wait. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {requests}/s | Gauge | Double | + +### sqlserver.lock.wait_time.avg + +Average wait time for all lock requests that had to wait. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Double | + +### sqlserver.page.buffer_cache.hit_ratio + +Pages found in the buffer pool without having to read from disk. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +### sqlserver.page.checkpoint.flush.rate + +Number of pages flushed by operations requiring dirty pages to be flushed. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {pages}/s | Gauge | Double | + +### sqlserver.page.lazy_write.rate + +Number of lazy writes moving dirty pages to disk. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {writes}/s | Gauge | Double | + +### sqlserver.page.life_expectancy + +Time a page will stay in the buffer pool. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| s | Gauge | Int | + +### sqlserver.page.operation.rate + +Number of physical database page operations issued. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {operations}/s | Gauge | Double | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| type | The page operation types. | Str: ``read``, ``write`` | + +### sqlserver.page.split.rate + +Number of pages split as a result of overflowing index pages. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {pages}/s | Gauge | Double | + +### sqlserver.transaction.rate + +Number of transactions started for the database (not including XTP-only transactions). + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {transactions}/s | Gauge | Double | + +### sqlserver.transaction.write.rate + +Number of transactions that wrote to the database and committed. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {transactions}/s | Gauge | Double | + +### sqlserver.transaction_log.flush.data.rate + +Total number of log bytes flushed. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| By/s | Gauge | Double | + +### sqlserver.transaction_log.flush.rate + +Number of log flushes. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {flushes}/s | Gauge | Double | + +### sqlserver.transaction_log.flush.wait.rate + +Number of commits waiting for a transaction log flush. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {commits}/s | Gauge | Double | + +### sqlserver.transaction_log.growth.count + +Total number of transaction log expansions for a database. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {growths} | Sum | Int | Cumulative | true | + +### sqlserver.transaction_log.shrink.count + +Total number of transaction log shrinks for a database. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {shrinks} | Sum | Int | Cumulative | true | + +### sqlserver.transaction_log.usage + +Percent of transaction log space used. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Int | + +### sqlserver.user.connection.count + +Number of users connected to the SQL Server. -| Name | Description | Type | -| ---- | ----------- | ---- | -| sqlserver.database.name | The name of the SQL Server database. | Str | +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {connections} | Gauge | Int | -## Metric attributes +## Resource Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| page.operations (type) | The page operation types. | read, write | +| sqlserver.database.name | The name of the SQL Server database. | Any Str | diff --git a/receiver/vcenterreceiver/documentation.md b/receiver/vcenterreceiver/documentation.md index de95372a2433..0d8276ee6594 100644 --- a/receiver/vcenterreceiver/documentation.md +++ b/receiver/vcenterreceiver/documentation.md @@ -2,75 +2,755 @@ # vcenterreceiver -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **vcenter.cluster.cpu.effective** | The effective CPU available to the cluster. This value excludes CPU from hosts in maintenance mode or are unresponsive. | {MHz} | Sum(Int) |
| -| **vcenter.cluster.cpu.limit** | The amount of CPU available to the cluster. | {MHz} | Sum(Int) |
| -| **vcenter.cluster.host.count** | The number of hosts in the cluster. | {hosts} | Sum(Int) |
  • host_effective
| -| **vcenter.cluster.memory.effective** | The effective memory of the cluster. This value excludes memory from hosts in maintenance mode or are unresponsive. | By | Sum(Int) |
| -| **vcenter.cluster.memory.limit** | The available memory of the cluster. | By | Sum(Int) |
| -| **vcenter.cluster.memory.used** | The memory that is currently used by the cluster. | By | Sum(Int) |
| -| **vcenter.cluster.vm.count** | the number of virtual machines in the cluster. | {virtual_machines} | Sum(Int) |
  • vm_count_power_state
| -| **vcenter.datastore.disk.usage** | The amount of space in the datastore. | By | Sum(Int) |
  • disk_state
| -| **vcenter.datastore.disk.utilization** | The utilization of the datastore. | % | Gauge(Double) |
| -| **vcenter.host.cpu.usage** | The amount of CPU in Hz used by the host. | MHz | Sum(Int) |
| -| **vcenter.host.cpu.utilization** | The CPU utilization of the host system. | % | Gauge(Double) |
| -| **vcenter.host.disk.latency.avg** | The latency of operations to the host system's disk. This latency is the sum of the device and kernel read and write latencies. Requires Performance Counter level 2 for metric to populate. | ms | Gauge(Int) |
  • disk_direction
| -| **vcenter.host.disk.latency.max** | Highest latency value across all disks used by the host. As measured over the most recent 20s interval. Requires Performance Level 3. | ms | Gauge(Int) |
| -| **vcenter.host.disk.throughput** | Average number of kilobytes read from or written to the disk each second. As measured over the most recent 20s interval. Aggregated disk I/O rate. Requires Performance Level 4. | {KiBy/s} | Sum(Int) |
  • disk_direction
| -| **vcenter.host.memory.usage** | The amount of memory the host system is using. | MiBy | Sum(Int) |
| -| **vcenter.host.memory.utilization** | The percentage of the host system's memory capacity that is being utilized. | % | Gauge(Double) |
| -| **vcenter.host.network.packet.count** | The number of packets transmitted and received, as measured over the most recent 20s interval. | {packets/sec} | Sum(Int) |
  • throughput_direction
| -| **vcenter.host.network.packet.errors** | The summation of packet errors on the host network. As measured over the most recent 20s interval. | {errors} | Sum(Int) |
  • throughput_direction
| -| **vcenter.host.network.throughput** | The amount of data that was transmitted or received over the network by the host. As measured over the most recent 20s interval. | {KiBy/s} | Sum(Int) |
  • throughput_direction
| -| **vcenter.host.network.usage** | The sum of the data transmitted and received for all the NIC instances of the host. | {KiBy/s} | Sum(Int) |
| -| **vcenter.resource_pool.cpu.shares** | The amount of shares of CPU in the resource pool. | {shares} | Sum(Int) |
| -| **vcenter.resource_pool.cpu.usage** | The usage of the CPU used by the resource pool. | {MHz} | Sum(Int) |
| -| **vcenter.resource_pool.memory.shares** | The amount of shares of memory in the resource pool. | {shares} | Sum(Int) |
| -| **vcenter.resource_pool.memory.usage** | The usage of the memory by the resource pool. | MiBy | Sum(Int) |
| -| **vcenter.vm.disk.latency.avg** | The latency of operations to the virtual machine's disk. Requires Performance Counter level 2 for metric to populate. As measured over the most recent 20s interval. | ms | Gauge(Int) |
  • disk_direction
  • disk_type
| -| **vcenter.vm.disk.latency.max** | The highest reported total latency (device and kernel times) over an interval of 20 seconds. | ms | Gauge(Int) |
| -| **vcenter.vm.disk.throughput** | The throughput of the virtual machine's disk. | By/sec | Sum(Int) |
| -| **vcenter.vm.disk.usage** | The amount of storage space used by the virtual machine. | By | Sum(Int) |
  • disk_state
| -| **vcenter.vm.disk.utilization** | The utilization of storage on the virtual machine. | % | Gauge(Double) |
| -| **vcenter.vm.memory.ballooned** | The amount of memory that is ballooned due to virtualization. | By | Sum(Int) |
| -| **vcenter.vm.memory.usage** | The amount of memory that is used by the virtual machine. | MiBy | Sum(Int) |
| -| **vcenter.vm.network.packet.count** | The amount of packets that was received or transmitted over the instance's network. | {packets/sec} | Sum(Int) |
  • throughput_direction
| -| **vcenter.vm.network.throughput** | The amount of data that was transmitted or received over the network of the virtual machine. As measured over the most recent 20s interval. | By/sec | Sum(Int) |
  • throughput_direction
| -| **vcenter.vm.network.usage** | The network utilization combined transmit and receive rates during an interval. As measured over the most recent 20s interval. | {KiBy/s} | Sum(Int) |
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: + +```yaml +metrics: + : + enabled: false +``` + +### vcenter.cluster.cpu.effective + +The effective CPU available to the cluster. This value excludes CPU from hosts in maintenance mode or are unresponsive. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {MHz} | Sum | Int | Cumulative | false | + +### vcenter.cluster.cpu.limit + +The amount of CPU available to the cluster. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {MHz} | Sum | Int | Cumulative | false | + +### vcenter.cluster.host.count + +The number of hosts in the cluster. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {hosts} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| effective | Whether the host is effective in the vCenter cluster. | Any Bool | + +### vcenter.cluster.memory.effective + +The effective memory of the cluster. This value excludes memory from hosts in maintenance mode or are unresponsive. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### vcenter.cluster.memory.limit + +The available memory of the cluster. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### vcenter.cluster.memory.used + +The memory that is currently used by the cluster. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### vcenter.cluster.vm.count + +the number of virtual machines in the cluster. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {virtual_machines} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| power_state | Whether the virtual machines are powered on or off. | Str: ``on``, ``off`` | + +### vcenter.datastore.disk.usage + +The amount of space in the datastore. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_state | The state of storage and whether it is already allocated or free. | Str: ``available``, ``used`` | + +### vcenter.datastore.disk.utilization + +The utilization of the datastore. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +### vcenter.host.cpu.usage + +The amount of CPU in Hz used by the host. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| MHz | Sum | Int | Cumulative | false | + +### vcenter.host.cpu.utilization + +The CPU utilization of the host system. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +### vcenter.host.disk.latency.avg + +The latency of operations to the host system's disk. + +This latency is the sum of the device and kernel read and write latencies. Requires Performance Counter level 2 for metric to populate. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of disk latency. | Str: ``read``, ``write`` | + +### vcenter.host.disk.latency.max + +Highest latency value across all disks used by the host. + +As measured over the most recent 20s interval. Requires Performance Level 3. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +### vcenter.host.disk.throughput + +Average number of kilobytes read from or written to the disk each second. + +As measured over the most recent 20s interval. Aggregated disk I/O rate. Requires Performance Level 4. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {KiBy/s} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of disk latency. | Str: ``read``, ``write`` | + +### vcenter.host.memory.usage + +The amount of memory the host system is using. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| MiBy | Sum | Int | Cumulative | false | + +### vcenter.host.memory.utilization + +The percentage of the host system's memory capacity that is being utilized. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +### vcenter.host.network.packet.count + +The number of packets transmitted and received, as measured over the most recent 20s interval. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets/sec} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` | + +### vcenter.host.network.packet.errors + +The summation of packet errors on the host network. + +As measured over the most recent 20s interval. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {errors} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` | + +### vcenter.host.network.throughput + +The amount of data that was transmitted or received over the network by the host. + +As measured over the most recent 20s interval. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {KiBy/s} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` | + +### vcenter.host.network.usage + +The sum of the data transmitted and received for all the NIC instances of the host. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {KiBy/s} | Sum | Int | Cumulative | false | + +### vcenter.resource_pool.cpu.shares + +The amount of shares of CPU in the resource pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {shares} | Sum | Int | Cumulative | false | + +### vcenter.resource_pool.cpu.usage + +The usage of the CPU used by the resource pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {MHz} | Sum | Int | Cumulative | false | + +### vcenter.resource_pool.memory.shares + +The amount of shares of memory in the resource pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {shares} | Sum | Int | Cumulative | false | + +### vcenter.resource_pool.memory.usage + +The usage of the memory by the resource pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| MiBy | Sum | Int | Cumulative | false | + +### vcenter.vm.disk.latency.avg + +The latency of operations to the virtual machine's disk. + +Requires Performance Counter level 2 for metric to populate. As measured over the most recent 20s interval. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of disk latency. | Str: ``read``, ``write`` | +| disk_type | The type of storage device that is being recorded. | Str: ``virtual``, ``physical`` | + +### vcenter.vm.disk.latency.max + +The highest reported total latency (device and kernel times) over an interval of 20 seconds. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +### vcenter.vm.disk.throughput + +The throughput of the virtual machine's disk. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By/sec | Sum | Int | Cumulative | false | + +### vcenter.vm.disk.usage + +The amount of storage space used by the virtual machine. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_state | The state of storage and whether it is already allocated or free. | Str: ``available``, ``used`` | + +### vcenter.vm.disk.utilization + +The utilization of storage on the virtual machine. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +### vcenter.vm.memory.ballooned + +The amount of memory that is ballooned due to virtualization. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### vcenter.vm.memory.usage + +The amount of memory that is used by the virtual machine. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| MiBy | Sum | Int | Cumulative | false | + +### vcenter.vm.network.packet.count + +The amount of packets that was received or transmitted over the instance's network. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets/sec} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` | + +### vcenter.vm.network.throughput + +The amount of data that was transmitted or received over the network of the virtual machine. + +As measured over the most recent 20s interval. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By/sec | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` | + +### vcenter.vm.network.usage + +The network utilization combined transmit and receive rates during an interval. + +As measured over the most recent 20s interval. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {KiBy/s} | Sum | Int | Cumulative | false | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Resource attributes +### vcenter.cluster.cpu.effective + +The effective CPU available to the cluster. This value excludes CPU from hosts in maintenance mode or are unresponsive. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {MHz} | Sum | Int | Cumulative | false | + +### vcenter.cluster.cpu.limit + +The amount of CPU available to the cluster. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {MHz} | Sum | Int | Cumulative | false | + +### vcenter.cluster.host.count + +The number of hosts in the cluster. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {hosts} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| effective | Whether the host is effective in the vCenter cluster. | Any Bool | + +### vcenter.cluster.memory.effective + +The effective memory of the cluster. This value excludes memory from hosts in maintenance mode or are unresponsive. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### vcenter.cluster.memory.limit + +The available memory of the cluster. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### vcenter.cluster.memory.used + +The memory that is currently used by the cluster. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### vcenter.cluster.vm.count + +the number of virtual machines in the cluster. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {virtual_machines} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| power_state | Whether the virtual machines are powered on or off. | Str: ``on``, ``off`` | + +### vcenter.datastore.disk.usage + +The amount of space in the datastore. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_state | The state of storage and whether it is already allocated or free. | Str: ``available``, ``used`` | + +### vcenter.datastore.disk.utilization + +The utilization of the datastore. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +### vcenter.host.cpu.usage + +The amount of CPU in Hz used by the host. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| MHz | Sum | Int | Cumulative | false | + +### vcenter.host.cpu.utilization + +The CPU utilization of the host system. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +### vcenter.host.disk.latency.avg + +The latency of operations to the host system's disk. + +This latency is the sum of the device and kernel read and write latencies. Requires Performance Counter level 2 for metric to populate. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of disk latency. | Str: ``read``, ``write`` | + +### vcenter.host.disk.latency.max + +Highest latency value across all disks used by the host. + +As measured over the most recent 20s interval. Requires Performance Level 3. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +### vcenter.host.disk.throughput + +Average number of kilobytes read from or written to the disk each second. + +As measured over the most recent 20s interval. Aggregated disk I/O rate. Requires Performance Level 4. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {KiBy/s} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of disk latency. | Str: ``read``, ``write`` | + +### vcenter.host.memory.usage + +The amount of memory the host system is using. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| MiBy | Sum | Int | Cumulative | false | + +### vcenter.host.memory.utilization + +The percentage of the host system's memory capacity that is being utilized. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +### vcenter.host.network.packet.count + +The number of packets transmitted and received, as measured over the most recent 20s interval. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets/sec} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` | + +### vcenter.host.network.packet.errors + +The summation of packet errors on the host network. + +As measured over the most recent 20s interval. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {errors} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` | + +### vcenter.host.network.throughput + +The amount of data that was transmitted or received over the network by the host. + +As measured over the most recent 20s interval. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {KiBy/s} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` | + +### vcenter.host.network.usage + +The sum of the data transmitted and received for all the NIC instances of the host. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {KiBy/s} | Sum | Int | Cumulative | false | + +### vcenter.resource_pool.cpu.shares + +The amount of shares of CPU in the resource pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {shares} | Sum | Int | Cumulative | false | + +### vcenter.resource_pool.cpu.usage + +The usage of the CPU used by the resource pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {MHz} | Sum | Int | Cumulative | false | + +### vcenter.resource_pool.memory.shares + +The amount of shares of memory in the resource pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {shares} | Sum | Int | Cumulative | false | + +### vcenter.resource_pool.memory.usage + +The usage of the memory by the resource pool. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| MiBy | Sum | Int | Cumulative | false | + +### vcenter.vm.disk.latency.avg + +The latency of operations to the virtual machine's disk. + +Requires Performance Counter level 2 for metric to populate. As measured over the most recent 20s interval. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of disk latency. | Str: ``read``, ``write`` | +| disk_type | The type of storage device that is being recorded. | Str: ``virtual``, ``physical`` | + +### vcenter.vm.disk.latency.max + +The highest reported total latency (device and kernel times) over an interval of 20 seconds. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +### vcenter.vm.disk.throughput + +The throughput of the virtual machine's disk. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By/sec | Sum | Int | Cumulative | false | + +### vcenter.vm.disk.usage + +The amount of storage space used by the virtual machine. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| disk_state | The state of storage and whether it is already allocated or free. | Str: ``available``, ``used`` | + +### vcenter.vm.disk.utilization + +The utilization of storage on the virtual machine. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| % | Gauge | Double | + +### vcenter.vm.memory.ballooned + +The amount of memory that is ballooned due to virtualization. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### vcenter.vm.memory.usage + +The amount of memory that is used by the virtual machine. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| MiBy | Sum | Int | Cumulative | false | + +### vcenter.vm.network.packet.count + +The amount of packets that was received or transmitted over the instance's network. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets/sec} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` | + +### vcenter.vm.network.throughput + +The amount of data that was transmitted or received over the network of the virtual machine. + +As measured over the most recent 20s interval. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By/sec | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | The direction of network throughput. | Str: ``transmitted``, ``received`` | + +### vcenter.vm.network.usage + +The network utilization combined transmit and receive rates during an interval. + +As measured over the most recent 20s interval. -| Name | Description | Type | -| ---- | ----------- | ---- | -| vcenter.cluster.name | The name of the vCenter Cluster. | Str | -| vcenter.datastore.name | The name of the vCenter datastore. | Str | -| vcenter.host.name | The hostname of the vCenter ESXi host. | Str | -| vcenter.resource_pool.name | The name of the resource pool. | Str | -| vcenter.vm.id | The instance UUID of the virtual machine. | Str | -| vcenter.vm.name | The name of the virtual machine. | Str | +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {KiBy/s} | Sum | Int | Cumulative | false | -## Metric attributes +## Resource Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| disk_direction (direction) | The direction of disk latency. | read, write | -| disk_state | The state of storage and whether it is already allocated or free. | available, used | -| disk_type | The type of storage device that is being recorded. | virtual, physical | -| host_effective (effective) | Whether the host is effective in the vCenter cluster. | | -| latency_type (type) | The type of disk latency being reported. | kernel, device | -| throughput_direction (direction) | The direction of network throughput. | transmitted, received | -| vm_count_power_state (power_state) | Whether the virtual machines are powered on or off. | on, off | +| vcenter.cluster.name | The name of the vCenter Cluster. | Any Str | +| vcenter.datastore.name | The name of the vCenter datastore. | Any Str | +| vcenter.host.name | The hostname of the vCenter ESXi host. | Any Str | +| vcenter.resource_pool.name | The name of the resource pool. | Any Str | +| vcenter.vm.id | The instance UUID of the virtual machine. | Any Str | +| vcenter.vm.name | The name of the virtual machine. | Any Str | diff --git a/receiver/zookeeperreceiver/documentation.md b/receiver/zookeeperreceiver/documentation.md index 6d23c2cf59dd..766ded6efb1a 100644 --- a/receiver/zookeeperreceiver/documentation.md +++ b/receiver/zookeeperreceiver/documentation.md @@ -2,47 +2,293 @@ # zookeeperreceiver -## Metrics - -These are the metrics available for this scraper. - -| Name | Description | Unit | Type | Attributes | -| ---- | ----------- | ---- | ---- | ---------- | -| **zookeeper.connection.active** | Number of active clients connected to a ZooKeeper server. | {connections} | Sum(Int) |
| -| **zookeeper.data_tree.ephemeral_node.count** | Number of ephemeral nodes that a ZooKeeper server has in its data tree. | {nodes} | Sum(Int) |
| -| **zookeeper.data_tree.size** | Size of data in bytes that a ZooKeeper server has in its data tree. | By | Sum(Int) |
| -| **zookeeper.file_descriptor.limit** | Maximum number of file descriptors that a ZooKeeper server can open. | {file_descriptors} | Gauge(Int) |
| -| **zookeeper.file_descriptor.open** | Number of file descriptors that a ZooKeeper server has open. | {file_descriptors} | Sum(Int) |
| -| **zookeeper.follower.count** | The number of followers. Only exposed by the leader. | {followers} | Sum(Int) |
  • state
| -| **zookeeper.fsync.exceeded_threshold.count** | Number of times fsync duration has exceeded warning threshold. | {events} | Sum(Int) |
| -| **zookeeper.latency.avg** | Average time in milliseconds for requests to be processed. | ms | Gauge(Int) |
| -| **zookeeper.latency.max** | Maximum time in milliseconds for requests to be processed. | ms | Gauge(Int) |
| -| **zookeeper.latency.min** | Minimum time in milliseconds for requests to be processed. | ms | Gauge(Int) |
| -| **zookeeper.packet.count** | The number of ZooKeeper packets received or sent by a server. | {packets} | Sum(Int) |
  • direction
| -| **zookeeper.request.active** | Number of currently executing requests. | {requests} | Sum(Int) |
| -| **zookeeper.sync.pending** | The number of pending syncs from the followers. Only exposed by the leader. | {syncs} | Sum(Int) |
| -| **zookeeper.watch.count** | Number of watches placed on Z-Nodes on a ZooKeeper server. | {watches} | Sum(Int) |
| -| **zookeeper.znode.count** | Number of z-nodes that a ZooKeeper server has in its data tree. | {znodes} | Sum(Int) |
| - -**Highlighted metrics** are emitted by default. Other metrics are optional and not emitted by default. -Any metric can be enabled or disabled with the following scraper configuration: +## Default Metrics + +The following metrics are emitted by default. Each of them can be disabled by applying the following configuration: + +```yaml +metrics: + : + enabled: false +``` + +### zookeeper.connection.active + +Number of active clients connected to a ZooKeeper server. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +### zookeeper.data_tree.ephemeral_node.count + +Number of ephemeral nodes that a ZooKeeper server has in its data tree. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {nodes} | Sum | Int | Cumulative | false | + +### zookeeper.data_tree.size + +Size of data in bytes that a ZooKeeper server has in its data tree. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### zookeeper.file_descriptor.limit + +Maximum number of file descriptors that a ZooKeeper server can open. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {file_descriptors} | Gauge | Int | + +### zookeeper.file_descriptor.open + +Number of file descriptors that a ZooKeeper server has open. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {file_descriptors} | Sum | Int | Cumulative | false | + +### zookeeper.follower.count + +The number of followers. Only exposed by the leader. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {followers} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | State of followers | Str: ``synced``, ``unsynced`` | + +### zookeeper.fsync.exceeded_threshold.count + +Number of times fsync duration has exceeded warning threshold. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {events} | Sum | Int | Cumulative | true | + +### zookeeper.latency.avg + +Average time in milliseconds for requests to be processed. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +### zookeeper.latency.max + +Maximum time in milliseconds for requests to be processed. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +### zookeeper.latency.min + +Minimum time in milliseconds for requests to be processed. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +### zookeeper.packet.count + +The number of ZooKeeper packets received or sent by a server. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | State of a packet based on io direction. | Str: ``received``, ``sent`` | + +### zookeeper.request.active + +Number of currently executing requests. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | false | + +### zookeeper.sync.pending + +The number of pending syncs from the followers. Only exposed by the leader. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {syncs} | Sum | Int | Cumulative | false | + +### zookeeper.watch.count + +Number of watches placed on Z-Nodes on a ZooKeeper server. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {watches} | Sum | Int | Cumulative | false | + +### zookeeper.znode.count + +Number of z-nodes that a ZooKeeper server has in its data tree. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {znodes} | Sum | Int | Cumulative | false | + +## Optional Metrics + +The following metrics are not emitted by default. Each of them can be enabled by applying the following configuration: ```yaml metrics: : - enabled: + enabled: true ``` -## Resource attributes +### zookeeper.connection.active + +Number of active clients connected to a ZooKeeper server. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {connections} | Sum | Int | Cumulative | false | + +### zookeeper.data_tree.ephemeral_node.count + +Number of ephemeral nodes that a ZooKeeper server has in its data tree. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {nodes} | Sum | Int | Cumulative | false | + +### zookeeper.data_tree.size + +Size of data in bytes that a ZooKeeper server has in its data tree. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| By | Sum | Int | Cumulative | false | + +### zookeeper.file_descriptor.limit + +Maximum number of file descriptors that a ZooKeeper server can open. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| {file_descriptors} | Gauge | Int | + +### zookeeper.file_descriptor.open + +Number of file descriptors that a ZooKeeper server has open. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {file_descriptors} | Sum | Int | Cumulative | false | + +### zookeeper.follower.count + +The number of followers. Only exposed by the leader. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {followers} | Sum | Int | Cumulative | false | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| state | State of followers | Str: ``synced``, ``unsynced`` | + +### zookeeper.fsync.exceeded_threshold.count + +Number of times fsync duration has exceeded warning threshold. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {events} | Sum | Int | Cumulative | true | + +### zookeeper.latency.avg + +Average time in milliseconds for requests to be processed. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +### zookeeper.latency.max + +Maximum time in milliseconds for requests to be processed. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +### zookeeper.latency.min + +Minimum time in milliseconds for requests to be processed. + +| Unit | Metric Type | Value Type | +| ---- | ----------- | ---------- | +| ms | Gauge | Int | + +### zookeeper.packet.count + +The number of ZooKeeper packets received or sent by a server. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {packets} | Sum | Int | Cumulative | true | + +#### Attributes + +| Name | Description | Values | +| ---- | ----------- | ------ | +| direction | State of a packet based on io direction. | Str: ``received``, ``sent`` | + +### zookeeper.request.active + +Number of currently executing requests. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {requests} | Sum | Int | Cumulative | false | + +### zookeeper.sync.pending + +The number of pending syncs from the followers. Only exposed by the leader. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {syncs} | Sum | Int | Cumulative | false | + +### zookeeper.watch.count + +Number of watches placed on Z-Nodes on a ZooKeeper server. + +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {watches} | Sum | Int | Cumulative | false | + +### zookeeper.znode.count + +Number of z-nodes that a ZooKeeper server has in its data tree. -| Name | Description | Type | -| ---- | ----------- | ---- | -| server.state | State of the Zookeeper server (leader, standalone or follower). | Str | -| zk.version | Zookeeper version of the instance. | Str | +| Unit | Metric Type | Value Type | Aggregation Temporality | Monotonic | +| ---- | ----------- | ---------- | ----------------------- | --------- | +| {znodes} | Sum | Int | Cumulative | false | -## Metric attributes +## Resource Attributes | Name | Description | Values | | ---- | ----------- | ------ | -| direction | State of a packet based on io direction. | received, sent | -| state | State of followers | synced, unsynced | +| server.state | State of the Zookeeper server (leader, standalone or follower). | Any Str | +| zk.version | Zookeeper version of the instance. | Any Str |