prometheus-community / prometheus-community/stackdriver_exporter

misguiding docs: GCP DELTA metrics are exported as Histogram

Open
#65 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
295
Forks
117
Avg merge
9d 14h
Merged PRs (30d)
7

Description

Hello,

In stackdriver_exporter documentation specified that GCP metric of type DELTA is exported as Gauge, but it is not true.
I encountered a case where it was exported as Histogram.

# HELP stackdriver_bigtable_table_bigtable_googleapis_com_server_latencies Distribution of server request latencies for a table, measured when calls reach Cloud Bigtable.
# TYPE stackdriver_bigtable_table_bigtable_googleapis_com_server_latencies histogram
stackdriver_bigtable_table_bigtable_googleapis_com_server_latencies_bucket{app_profile="default",cluster="NONE",instance="NONE",method="Bigtable.MutateRow",project_id="NONE",table="NONE",unit="ms",zone="us-central1-a",le="0"} 0
stackdriver_bigtable_table_bigtable_googleapis_com_server_request_count{app_profile="default",cluster="NONE",instance="NONE",method="Bigtable.MutateRow",project_id="NONE",table="NONE",unit="1",zone="us-central1-a"} 6

Here is a GCP doc.
I suggest to update the documentation or fix a bug in case export to Histogram was unintended by exporter logic.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the documentation statement about GCP DELTA metrics with the linked Google Cloud metric documentation and the reported Bigtable output. Trace the exporter behavior for the cited metric, then either align the documentation with the observed Histogram output or establish that the exporter behavior should change; done means the discrepancy and intended behavior are resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, google-cloud
Domain
observability
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.