diff --git a/deploy/docs/additional_prometheus_configuration.md b/deploy/docs/additional_prometheus_configuration.md index 43aa0f7123..bfc10b286c 100644 --- a/deploy/docs/additional_prometheus_configuration.md +++ b/deploy/docs/additional_prometheus_configuration.md @@ -29,13 +29,12 @@ The configuration contains a section like the following for each of the Kubernet If you would like to collect other metrics that are not listed in configuration, you can add a new section to the file. +NOTE: Please add the below configuration to a user-supplied values file (```helm install -f my_values.yaml -n sumologic```) + ```yaml -kube-prometheus-stack: # For values.yaml - # ... +kube-prometheus-stack: # Add to a user-supplied values.yaml prometheus: - # ... prometheusSpec: - # ... additionalRemoteWrite: - url: http://$(FLUENTD_METRICS_SVC).$(NAMESPACE).svc.cluster.local.:9888/prometheus.metrics. writeRelabelConfigs: @@ -158,13 +157,12 @@ Once you have created this yaml file, go ahead and run `kubectl create -f name_o If you want to keep all your changes inside configuration instead of serviceMonitors, you can add your changes to `prometheus.additionalServiceMonitors` section. For given serviceMonitor configuration it should looks like snippet below: +NOTE: Please add the below configuration to a user-supplied values file (```helm install -f my_values.yaml -n sumologic```) + ```yaml -kube-prometheus-stack: # For values.yaml - # ... +kube-prometheus-stack: # Add to user-supplied my_values.yaml prometheus: - # ... additionalServiceMonitors: - # ... - name: my-metrics additionalLabels: app: my-metrics @@ -195,15 +193,13 @@ annotations: To avoid [blacklisting](https://help.sumologic.com/Metrics/Understand_and_Manage_Metric_Volume/Blacklisted_Metrics_Sources) metrics should be distributed across multiple HTTP sources. You can create a new HTTP source using `values.yaml`: +NOTE: Please add the below configuration to a user-supplied values file (```helm install -f my_values.yaml -n sumologic```) + ```yaml sumologic: - # ... collector: - # ... sources: - # ... metrics: - # ... my_source: name: my-source-name ``` @@ -270,13 +266,12 @@ To send custom metrics to Sumo Logic you need to update it to include a rule to Make sure you include the same tag you created in your Fluentd configmap in the previous step. Here is an example addition to the configuration file that will forward metrics to Sumo: +NOTE: Please add the below to a user-supplied values file (```helm install -f```) + ```yaml -kube-prometheus-stack: # For values.yaml - # ... +kube-prometheus-stack: # Add to a user-supplied values.yaml prometheus: - # ... prometheusSpec: - # ... additionalRemoteWrite: - url: http://$(FLUENTD_METRICS_SVC).$(NAMESPACE).svc.cluster.local.:9888/prometheus.metrics.YOUR_TAG writeRelabelConfigs: @@ -288,12 +283,9 @@ kube-prometheus-stack: # For values.yaml According to our example, below config could be useful: ```yaml -kube-prometheus-stack: # For values.yaml - # ... +kube-prometheus-stack: # Add to a user-supplied values.yaml prometheus: - # ... prometheusSpec: - # ... additionalRemoteWrite: - url: http://$(FLUENTD_METRICS_SVC).$(NAMESPACE).svc.cluster.local.:9888/prometheus.metrics.YOUR_TAG writeRelabelConfigs: