docs: update documentation for additionalRemoteWrite #2549
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| @@ -36,7 +36,7 @@ kube-prometheus-stack: # For values.yaml | |||
| # ... | |||
| prometheusSpec: | |||
| # ... | |||
| remoteWrite: | |||
| additionalRemoteWrite: | |||
| # ... | |||
There was a problem hiding this comment.
no need for # ... it was indication that there was something to copy
also, we should search documentation for all remoteWrite mentions, as I'm not sure but we probably mention in multiple places that you need to copy it from our values.yaml which is no longer true
There was a problem hiding this comment.
ok got it, will look for other references to remoteWrite. Also, trying to send some metrics from the k8s-collector to a sumo instance. Will try adding additional prometheus metrics.
There was a problem hiding this comment.
get this error when I try to send Prometheus metrics to Sumo (long) via Fluentd.
config error file="/fluentd/etc/fluent.conf" error_class=Fluent::ConfigError error="Invalid SumoLogic endpoint url: "
it's not clear where in endpoint url gets configured in fluentd, configured the following in values.yaml
Sumo API endpoint; Leave blank for automatic endpoint discovery and redirection
endpoint: "https://long-api......."
There was a problem hiding this comment.
Also @sumo-drosiek there doesn't seem to be any other mention of copying remoteWrite from values.yaml in the documentation
There was a problem hiding this comment.
Was able to send additional Prometheus metrics from a new metrics source. Also, removed copy references from the readme and added a note like below
NOTE: It is best practice to add custom configuration to a user-supplied values file and then use it like so (helm install -f my_values.yaml -n sumologic)
rnishtala-sumo
force-pushed
the
rnishtala-doc-changes
branch
from
9d7ad30
to
1306225
Compare
rnishtala-sumo
force-pushed
the
rnishtala-doc-changes
branch
2 times, most recently
from
8639286
to
32e585a
Compare
| @@ -271,15 +268,13 @@ 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```) | |||
There was a problem hiding this comment.
ok makes sense, I could keep the one NOTE at the beginning and remove the rest of them. Would that work?
|
Generally I'm not sure about copying the same note in multiple places in one document cc: @astencel-sumo |
|
@rnishtala-sumo the CI should be fine if you rebase on |
rnishtala-sumo
force-pushed
the
rnishtala-doc-changes
branch
from
2dee63a
to
d38b96e
Compare
Adding a note about user-supplied yaml configuration Removed repeating note comments
rnishtala-sumo
force-pushed
the
rnishtala-doc-changes
branch
from
d38b96e
to
3a70858
Compare
|
Fixes issue: #1822 |
Description
Update documentation around additionalRemoteWrite for kube-prometheus-stack