[YSQL] Prometheus metrics endpoint :13000/prometheus-metrics missing HELP and TYPE metadata #23578
Closed
1 task done
Assignees
Labels
Comments
alencar
added
area/ysql
yugabyte-ci
added
kind/bug
|
Here is an example of what Datadog Agent 7.x does when it finds a metric without a TYPE |
yugabyte-ci
added
kind/enhancement
|
See also #17016 -- Most likely need to do the same thing for the 13000 endpoint. cc @kai-franz |
yugabyte-ci
added
kind/bug
kai-franz
added a commit
that referenced
this issue
Sep 11, 2024
Summary: Similar to D25254, adds the following metadata to the YSQL Prometheus metrics endpoint for each metric: - #HELP: A brief description of the metric - #TYPE: Type of the metric, in this case either gauge or counter. Gauge metrics can increase or decrease: for example, the number of YSQL connections is a gauge metric. Counters can only increase: for example, the number of select statements executed is a counter metric. By default, HELP and TYPE metadata are always shown. If a user wants to get the metrics without the metadata, they can use the `?show_help=false` URL parameter. Connection manager metric descriptions are taken from D27240. Also, move `ParseRequestOptions` out of the anonymous namespace in `default-path-handlers.cc` so that the pgsql webserver can use it. Jira: DB-12496 Test Plan: ``` ./yb_build.sh --cxx-test pgwrapper_pg_libpq-test --gtest_filter PgLibPqTest.CatalogCacheIdMissMetricsTest ./yb_build.sh --cxx-test pgwrapper_pg_libpq-test --gtest_filter PgLibPqTest.PrometheusMetricsHelpAndTypeTest ``` Reviewers: yyan, myang Reviewed By: myang Subscribers: svc_phabricator, esheng, yql, ybase Differential Revision: https://phorge.dev.yugabyte.com/D37766
jasonyb
pushed a commit
that referenced
this issue
Sep 12, 2024
Summary: f5ad1fb [#23855] Fixing the calculation of automatic refactoring count. eed826d [#22519] YSQL: Move ExplicitRowLockBuffer class into separate file 99a27e6 [PLAT-14522] Taking yba-ctl backups with prometheus HTTPS e2a84b0 [PLAT-15044] Add preflight check for node addition in provider 7e40d89 [#20769] XCluster: Dynamically apply cdc_wal_retention_time_secs for XCluster aa41478 [#23858] build: fix ./yb_build.sh release --gcc11 bcf7f47 [PLAT-13910] Improve IAM credentials fetch logging and add retries 303a202 [#23778] xCluster: Remove the capability to rename xCluster replication groups Excluded: 58fd26e [#23652] YSQL: Fix TestPgRegressAnalyze.java timeout / database drop failure on TSAN build 31da65b [doc] yb_enable_bitmapscan flag (#23854) 798db14 [#20335] DocDB: Use MonoClock for write query metric 80779d8 [#23860] xCluster: Add automatic ddl mode proto fields afd763d Revert "Revert "[PLAT-14786] Add support to node_agent install to use bind ip and node_external_fqdn"" e86951a [#23841] docdb: Disable stack trace tracking in TSAN builds d600608 [PLAT-15244] Fix schedule not getting updated on edit schedule API call 3c0df09 [PLAT-15214][PLAT-15232]YBC version upgrade to 2.2.0.0-b6 and enable YBC verbose by default aa7372e [#23478] YSQL: fix connection manager session variable case sensitivity issue 0d53558 [PLAT-14810][PLAT-14811][YBA CLI] Support adding and editing EIT configurations ffa537e [PLAT-10706][dr] Support retry-ability of failover and switchover Excluded: 5ae4558 [#23578] YSQL: Add HELP and TYPE to :13000/prometheus-metrics 3aa7459 [PLAT-15016] Handle gflag_group changes for ENHANCED_PG_COMPATIBILITY group in 2024.1.3 c89356c [PLAT-10592][YBA] Changes to support global tserver/master service in K8s 7fc3b76 [#3893] YCQL: Align 2 system_schema.* tables with Cassandra da6274e [23646] Test Stability: Fix PgMiniTest.FollowerReads 5fa6dc9 [PLAT-15180][Platform][UI][PITR]Create Restore Backup modal be0d1d1 [PLAT-15247][Platform][Backup]Create Backup scheduled policy List Test Plan: Jenkins: rebase: pg15-cherrypicks Reviewers: jason, tfoucher Subscribers: yql Differential Revision: https://phorge.dev.yugabyte.com/D37981
kai-franz
added a commit
that referenced
this issue
Sep 12, 2024
…/prometheus-metrics Summary: Original commit: 5ae4558 / D37766 Similar to D25254, adds the following metadata to the YSQL Prometheus metrics endpoint for each metric: - #HELP: A brief description of the metric - #TYPE: Type of the metric, in this case either gauge or counter. Gauge metrics can increase or decrease: for example, the number of YSQL connections is a gauge metric. Counters can only increase: for example, the number of select statements executed is a counter metric. By default, HELP and TYPE metadata are always shown. If a user wants to get the metrics without the metadata, they can use the `?show_help=false` URL parameter. Connection manager metric descriptions are taken from D27240. Also, move `ParseRequestOptions` out of the anonymous namespace in `default-path-handlers.cc` so that the pgsql webserver can use it. Jira: DB-12496 Test Plan: ``` ./yb_build.sh --cxx-test pgwrapper_pg_libpq-test --gtest_filter PgLibPqTest.CatalogCacheIdMissMetricsTest ./yb_build.sh --cxx-test pgwrapper_pg_libpq-test --gtest_filter PgLibPqTest.PrometheusMetricsHelpAndTypeTest ``` Reviewers: jason, tfoucher Reviewed By: jason Subscribers: ybase, yql, esheng, svc_phabricator Differential Revision: https://phorge.dev.yugabyte.com/D37995
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Jira Link: DB-12496
Description
Prometheus metrics endpoint is not consistent with other endpoints, which provides both HELP and TYPE metadata, unless
?show_help=trueis added to the request. Without HELP and TYPE metadata, integrations with tools like Datadog Agent 7.x breaks.Environment
Expected response
Response
Relates to #17297
Issue Type
kind/bug
Warning: Please confirm that this issue does not contain any sensitive information
The text was updated successfully, but these errors were encountered: