Skip to content

Commit

Permalink
maint: Update main documentation with 2.8.3 release (#1374)
Browse files Browse the repository at this point in the history
- Updates main branch to include documentation from 2.8.3 release

- update changelog
- update release notes
- run `make all`.

---------

Co-authored-by: Mike Goldsmith <goldsmith.mike@gmail.com>
  • Loading branch information
TylerHelmuth and MikeGoldsmith committed Oct 16, 2024
1 parent 0b377ac commit bebf49b
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 1 deletion.
1 change: 1 addition & 0 deletions collect/collect.go
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,7 @@ var inMemCollectorMetrics = []metrics.Metadata{
{Name: "trace_kept_sample_rate", Type: metrics.Histogram, Unit: metrics.Dimensionless, Description: "sample rate of kept traces"},
{Name: "trace_aggregate_sample_rate", Type: metrics.Histogram, Unit: metrics.Dimensionless, Description: "aggregate sample rate of both kept and dropped traces"},
{Name: "collector_redistribute_traces_duration_ms", Type: metrics.Histogram, Unit: metrics.Milliseconds, Description: "duration of redistributing traces to peers"},
{Name: "collector_collect_loop_duration_ms", Type: metrics.Gauge, Unit: metrics.Milliseconds, Description: "duration of the collect loop, the primary event processing goroutine"},
}

func (i *InMemCollector) Start() error {
Expand Down
4 changes: 3 additions & 1 deletion metrics.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Honeycomb Refinery Metrics Documentation

This document contains the description of various metrics used in Refinery.
It was automatically generated on 2024-09-27 at 16:19:55 UTC.
It was automatically generated on 2024-10-10 at 17:01:38 UTC.

Note: This document does not include metrics defined in the dynsampler-go dependency, as those metrics are generated dynamically at runtime. As a result, certain metrics may be missing or incomplete in this document, but they will still be available during execution with their full names.

Expand Down Expand Up @@ -58,6 +58,8 @@ This table includes metrics with fully defined names.
| dropped_from_stress | Counter | Dimensionless | number of traces dropped due to stress relief |
| trace_kept_sample_rate | Histogram | Dimensionless | sample rate of kept traces |
| trace_aggregate_sample_rate | Histogram | Dimensionless | aggregate sample rate of both kept and dropped traces |
| collector_redistribute_traces_duration_ms | Histogram | Milliseconds | duration of redistributing traces to peers |
| collector_collect_loop_duration_ms | Gauge | Milliseconds | duration of the collect loop, the primary event processing goroutine |
| cluster_stress_level | Gauge | Dimensionless | The overall stress level of the cluster |
| individual_stress_level | Gauge | Dimensionless | The stress level of the individual node |
| stress_level | Gauge | Dimensionless | The stress level that's being used to determine whether to activate stress relief |
Expand Down
8 changes: 8 additions & 0 deletions tools/convert/metricsMeta.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,14 @@ complete:
type: Histogram
unit: Dimensionless
description: aggregate sample rate of both kept and dropped traces
- name: collector_redistribute_traces_duration_ms
type: Histogram
unit: Milliseconds
description: duration of redistributing traces to peers
- name: collector_collect_loop_duration_ms
type: Gauge
unit: Milliseconds
description: duration of the collect loop, the primary event processing goroutine
- name: cluster_stress_level
type: Gauge
unit: Dimensionless
Expand Down

0 comments on commit bebf49b

Please sign in to comment.