Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding documentation page on what ElastAlert metrics are being exposed via --prometheus_port configuration flag #498

Merged
merged 7 commits into from
Oct 5, 2021

Conversation

xavigpich
Copy link
Contributor

@xavigpich xavigpich commented Oct 5, 2021

Description

This PR adds a new documentation page that explains what types of metrics can be exported when using the --prometheus_port configuration flag

Checklist

  • I have reviewed the contributing guidelines.
  • I have included unit tests for my changes or additions.
  • I have successfully run make test-docker with my changes.
  • I have manually tested all relevant modes of the change in this PR.
  • I have updated the documentation.
  • I have updated the changelog.

Comments

  • This is a documentation change, it does not require a unit test
  • I've tested it locally by running make html && open build/html/recipes/exposing_rule_metrics.html

@ferozsalam
Copy link
Collaborator

@thisisxgp you're getting a build rule error:

Warning, treated as error:
/home/elastalert/docs/source/recipes/exposing_rule_metrics.rst:4:duplicate label writingrules, other instance in /home/elastalert/docs/source/recipes/adding_rules.rst

@xavigpich
Copy link
Contributor Author

@thisisxgp you're getting a build rule error:

Warning, treated as error:
/home/elastalert/docs/source/recipes/exposing_rule_metrics.rst:4:duplicate label writingrules, other instance in /home/elastalert/docs/source/recipes/adding_rules.rst

Updated recipe page label to fix build error

@jertel
Copy link
Owner

jertel commented Oct 5, 2021

@thisisxgp Thanks for submitting this new documentation. Will you please add a link to your new page from the running_elastalert.html page, specifically the --prometheus_port parameter?
image

@xavigpich
Copy link
Contributor Author

@thisisxgp Thanks for submitting this new documentation. Will you please add a link to your new page from the running_elastalert.html page, specifically the --prometheus_port parameter? image

Added link to new documentation page

@xavigpich xavigpich closed this Oct 5, 2021
@xavigpich xavigpich reopened this Oct 5, 2021
@jertel jertel merged commit 503aea4 into jertel:master Oct 5, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 20, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants