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.

Sign up for GitHub

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

Jump to bottom

docs(metrics): available metrics, metrics enablement #3171

Merged

nitrocode merged 7 commits into runatlantis:main from Pardeep009:main

Mar 1, 2023

Contributor

Pardeep009 commented Feb 26, 2023 •

edited

Loading

what

Add documentation for

where to view list of all metrics exposed by atlantis.
explanation about some of those metrics.

why

There was a general documentation missing from the page Metrics/Stats about

where to find all of the metrics exposed by atlantis service
explanation about those metrics as well.

So, i have tried to cover these two points, although i have not covered for all of the metrics, but may be this can be taken as a starting point for adding documentations around other metrics as well in future.

tests

See below link to preview stats page

references

Preview stats page https://deploy-preview-3171--runatlantis.netlify.app/docs/stats.html#available-metrics-stats


          docs: documentation for available metrics/stats

febb83c

Pardeep009 force-pushed the main branch from b18ccdc to febb83c Compare

February 26, 2023 11:24

nitrocode reviewed

View reviewed changes

runatlantis.io/docs/stats.md Outdated Show resolved Hide resolved

nitrocode reviewed

View reviewed changes

runatlantis.io/docs/stats.md Outdated Show resolved Hide resolved

nitrocode reviewed

View reviewed changes

runatlantis.io/docs/stats.md Show resolved Hide resolved

nitrocode reviewed

View reviewed changes

runatlantis.io/docs/stats.md Outdated Show resolved Hide resolved

nitrocode reviewed

View reviewed changes

runatlantis.io/docs/stats.md Show resolved Hide resolved

nitrocode changed the title ~~docs: documentation for available metrics/stats~~ docs(metrics): available metrics, metrics enablement

nitrocode reviewed

View reviewed changes

runatlantis.io/docs/stats.md Outdated Show resolved Hide resolved

nitrocode reviewed

View reviewed changes

runatlantis.io/docs/stats.md Outdated Show resolved Hide resolved

nitrocode reviewed

View reviewed changes

runatlantis.io/docs/stats.md Outdated Show resolved Hide resolved

nitrocode reviewed

View reviewed changes

runatlantis.io/docs/stats.md Outdated Show resolved Hide resolved


          docs: refactored as per comments

9f83ece

nitrocode reviewed

View reviewed changes

runatlantis.io/docs/stats.md Outdated Show resolved Hide resolved

nitrocode reviewed

View reviewed changes

runatlantis.io/docs/stats.md Outdated Show resolved Hide resolved


          docs: update metrics description

af82da2

Pardeep009 marked this pull request as ready for review

March 1, 2023 15:13

Pardeep009 requested a review from a team as a code owner

March 1, 2023 15:13

github-actions bot added the docs label

nitrocode reviewed

View reviewed changes

runatlantis.io/docs/stats.md Show resolved Hide resolved

nitrocode reviewed

View reviewed changes

runatlantis.io/docs/stats.md Show resolved Hide resolved

nitrocode reviewed

View reviewed changes

runatlantis.io/docs/stats.md Show resolved Hide resolved

nitrocode reviewed

View reviewed changes

runatlantis.io/docs/stats.md Outdated Show resolved Hide resolved

Pardeep Bhatt added 3 commits

March 1, 2023 20:51


          docs: add empty lines between blocks

d55f879


          docs: add note section

0055e5d


          docs: add missing dot

9fa6149

Pardeep009 requested a review from nitrocode

March 1, 2023 16:55

nitrocode added this to the v0.23.0 milestone


          Apply suggestions from code review

8aa5fc8

nitrocode approved these changes

View reviewed changes

nitrocode merged commit ace0cd0 into runatlantis:main

Member

nitrocode commented Mar 1, 2023

Thank you @Pardeep009 ! Please feel free to propose any other PRs :)

albertorm95 mentioned this pull request

fix(metrics): add missing stat metric scopes #3416

Merged

ijames-gc pushed a commit to gocardless/atlantis that referenced this pull request


          docs(metrics): available metrics, metrics enablement (runatlantis#3171)

83a958a

* docs: documentation for available metrics/stats

* docs: refactored as per comments

* docs: update metrics description

* docs: add empty lines between blocks

* docs: add note section

* docs: add missing dot

* Apply suggestions from code review

---------

Co-authored-by: Pardeep Bhatt <pardeep.bhatt@gojek.com>
Co-authored-by: nitrocode <7775707+nitrocode@users.noreply.github.com>

ijames-gc pushed a commit to gocardless/atlantis that referenced this pull request


          docs(metrics): available metrics, metrics enablement (runatlantis#3171)

071f76d

* docs: documentation for available metrics/stats

* docs: refactored as per comments

* docs: update metrics description

* docs: add empty lines between blocks

* docs: add note section

* docs: add missing dot

* Apply suggestions from code review

---------

Co-authored-by: Pardeep Bhatt <pardeep.bhatt@gojek.com>
Co-authored-by: nitrocode <7775707+nitrocode@users.noreply.github.com>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs