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

feat(prometheus): add docs #427

Merged
merged 1 commit into from
May 7, 2020
Merged

feat(prometheus): add docs #427

merged 1 commit into from
May 7, 2020

Conversation

ecktom
Copy link
Contributor

@ecktom ecktom commented May 6, 2020

Proposed changes

Followup docs for #404

Checklist

  • I have read the contributing guidelines.
  • I have read the security policy.
  • I confirm that this pull request does not address a security
    vulnerability. If this pull request addresses a security. vulnerability, I
    confirm that I got green light (please contact
    [email protected]) from the maintainers to push
    the changes.
  • I have added tests that prove my fix is effective or that my feature
    works.
  • I have added or changed the documentation.

@aeneasr aeneasr self-requested a review May 6, 2020 10:23
@aeneasr aeneasr self-assigned this May 6, 2020
@aeneasr aeneasr added this to the v0.38.0 milestone May 6, 2020
Copy link
Member

@aeneasr aeneasr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome, thank you! Just a bit of restructuring:

  • Move .github/grafana/Oathkeeper-Dashboard.json to contrib/grafana/Oathkeeper-Dashboard.json
  • Move .github/grafana/grafana.png to https://github.com/ory/oathkeeper/tree/master/docs/static/img/docs/grafana.png

:)

Now where you have a basic monitoring setup running you can extend it by building up nice visualizations eg. using Grafana. More information are available on [https://prometheus.io/docs/visualization/grafana/](https://prometheus.io/docs/visualization/grafana/).

We have a pre built Dashboard which you can use to get started quickly:
[Oathkeeper-Dashboard.json](../../.github/grafana/Oathkeeper-Dashboard.json).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[Oathkeeper-Dashboard.json](../../.github/grafana/Oathkeeper-Dashboard.json).
[Oathkeeper-Dashboard.json](https://github.com/ory/oathkeeper/tree/master/contrib/grafana/Oathkeeper-Dashboard.json).

We have a pre built Dashboard which you can use to get started quickly:
[Oathkeeper-Dashboard.json](../../.github/grafana/Oathkeeper-Dashboard.json).

<img src="../../.github/grafana/grafana.png" alt="ORY Oathkeeper - Cloud Native Identity & Access Proxy">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<img
alt="ORY Oathkeeper with Prometheus and Grafana"
src={useBaseUrl('img/docs/grafana.png')}
/>

@ecktom ecktom force-pushed the feat/prom_docs branch 3 times, most recently from a469ffe to 04fe0e4 Compare May 6, 2020 20:28
@ecktom ecktom requested a review from aeneasr May 6, 2020 20:30
@ecktom ecktom force-pushed the feat/prom_docs branch from 04fe0e4 to d78baf4 Compare May 6, 2020 20:30
@aeneasr
Copy link
Member

aeneasr commented May 7, 2020

You're awesome, thanks!

@aeneasr aeneasr merged commit 117ee6a into ory:master May 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants