diff --git a/docs/guides/solr/monitoring/overview.md b/docs/guides/solr/monitoring/overview.md index 7297dbc41a..699d67cdbd 100644 --- a/docs/guides/solr/monitoring/overview.md +++ b/docs/guides/solr/monitoring/overview.md @@ -24,7 +24,7 @@ KubeDB has native support for monitoring via [Prometheus](https://prometheus.io/ KubeDB uses Prometheus [exporter](https://prometheus.io/docs/instrumenting/exporters/#databases) images to export Prometheus metrics for respective databases. Following diagram shows the logical flow of database monitoring with KubeDB.

-  Database Monitoring Flow +  Database Monitoring Flow

When a user creates a database crd with `spec.monitor` section configured, KubeDB operator provisions the respective database and injects an exporter image as sidecar to the database pod. It also creates a dedicated stats service with name `{database-crd-name}-stats` for monitoring. Prometheus server can scrape metrics using this stats service. @@ -33,16 +33,16 @@ When a user creates a database crd with `spec.monitor` section configured, KubeD In order to enable monitoring for a database, you have to configure `spec.monitor` section. KubeDB provides following options to configure `spec.monitor` section: -| Field | Type | Uses | -| -------------------------------------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| Field | Type | Uses | +|----------------------------------------------------|------------|-----------------------------------------------------------------------------------------------------------------------------------------| | `spec.monitor.agent` | `Required` | Type of the monitoring agent that will be used to monitor this database. It can be `prometheus.io/builtin` or `prometheus.io/operator`. | -| `spec.monitor.prometheus.exporter.port` | `Optional` | Port number where the exporter side car will serve metrics. | -| `spec.monitor.prometheus.exporter.args` | `Optional` | Arguments to pass to the exporter sidecar. | -| `spec.monitor.prometheus.exporter.env` | `Optional` | List of environment variables to set in the exporter sidecar container. | -| `spec.monitor.prometheus.exporter.resources` | `Optional` | Resources required by exporter sidecar container. | -| `spec.monitor.prometheus.exporter.securityContext` | `Optional` | Security options the exporter should run with. | -| `spec.monitor.prometheus.serviceMonitor.labels` | `Optional` | Labels for `ServiceMonitor` crd. | -| `spec.monitor.prometheus.serviceMonitor.interval` | `Optional` | Interval at which metrics should be scraped. | +| `spec.monitor.prometheus.exporter.port` | `Optional` | Port number where the exporter side car will serve metrics. | +| `spec.monitor.prometheus.exporter.args` | `Optional` | Arguments to pass to the exporter sidecar. | +| `spec.monitor.prometheus.exporter.env` | `Optional` | List of environment variables to set in the exporter sidecar container. | +| `spec.monitor.prometheus.exporter.resources` | `Optional` | Resources required by exporter sidecar container. | +| `spec.monitor.prometheus.exporter.securityContext` | `Optional` | Security options the exporter should run with. | +| `spec.monitor.prometheus.serviceMonitor.labels` | `Optional` | Labels for `ServiceMonitor` crd. | +| `spec.monitor.prometheus.serviceMonitor.interval` | `Optional` | Interval at which metrics should be scraped. | ## Sample Configuration diff --git a/docs/images/solr/monitoring/database-monitoring-overview.png b/docs/images/solr/monitoring/database-monitoring-overview.png new file mode 100644 index 0000000000..55364953cb Binary files /dev/null and b/docs/images/solr/monitoring/database-monitoring-overview.png differ