clintropolis commented on a change in pull request #10412: URL: https://github.com/apache/druid/pull/10412#discussion_r584020750
########## File path: docs/development/extensions-contrib/prometheus.md ########## @@ -0,0 +1,70 @@ +--- +id: prometheus +title: "Prometheus Emitter" +--- + +<!-- + ~ Licensed to the Apache Software Foundation (ASF) under one + ~ or more contributor license agreements. See the NOTICE file + ~ distributed with this work for additional information + ~ regarding copyright ownership. The ASF licenses this file + ~ to you under the Apache License, Version 2.0 (the + ~ "License"); you may not use this file except in compliance + ~ with the License. You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, + ~ software distributed under the License is distributed on an + ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + ~ KIND, either express or implied. See the License for the + ~ specific language governing permissions and limitations + ~ under the License. + --> + + +To use this Apache Druid (incubating) extension, make sure to [include](../../development/extensions.md#loading-extensions) `prometheus-emitter` extension. Review comment: Druid is no longer in the Apache Incubator, so this `(incubating)` should be removed. ########## File path: docs/operations/metrics.md ########## @@ -284,9 +284,9 @@ These metrics are only available if the JVMMonitor module is included. |`jvm/pool/init`|Initial pool.|poolKind, poolName.|Varies.| |`jvm/pool/max`|Max pool.|poolKind, poolName.|Varies.| |`jvm/pool/used`|Pool used.|poolKind, poolName.|< max pool| -|`jvm/bufferpool/count`|Bufferpool count.|bufferpoolName.|Varies.| -|`jvm/bufferpool/used`|Bufferpool used.|bufferpoolName.|close to capacity| -|`jvm/bufferpool/capacity`|Bufferpool capacity.|bufferpoolName.|Varies.| +|`jvm/bufferpool/count`|Bufferpool count.|bufferPoolName.|Varies.| Review comment: I don't think this change should have happened? `bufferpoolName` still appears to be the dimension name in `JvmMonitor` as far as I can tell. There are a few other places scattered around where this appears to have happened. Potentially this is a result of missing changes or resolving a conflict with https://github.com/apache/druid/pull/10075 ########## File path: docs/development/extensions-contrib/prometheus.md ########## @@ -0,0 +1,70 @@ +--- +id: prometheus +title: "Prometheus Emitter" +--- + +<!-- + ~ Licensed to the Apache Software Foundation (ASF) under one + ~ or more contributor license agreements. See the NOTICE file + ~ distributed with this work for additional information + ~ regarding copyright ownership. The ASF licenses this file + ~ to you under the Apache License, Version 2.0 (the + ~ "License"); you may not use this file except in compliance + ~ with the License. You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, + ~ software distributed under the License is distributed on an + ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + ~ KIND, either express or implied. See the License for the + ~ specific language governing permissions and limitations + ~ under the License. + --> + + +To use this Apache Druid (incubating) extension, make sure to [include](../../development/extensions.md#loading-extensions) `prometheus-emitter` extension. + +## Introduction + +This extension exposes Druid metrics for collection by a Prometheus server +(https://prometheus.io/) Review comment: It would be worth perhaps linking to metrics documentation https://druid.apache.org/docs/latest/operations/metrics.html (`[Druid Metrics](../../operations/metrics.md)`) and maybe emitter configuration stuffs, https://druid.apache.org/docs/latest/configuration/index.html#emitting-metrics (`[configuration](../../configuration/index.md#emitting-metrics`). Also, you should probably include instructions to add ```druid.emitter=prometheus``` to the configs. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
