Skip to content

Update chapter on metric-utility #3322

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Conversation

ianf77
Copy link
Contributor

@ianf77 ianf77 commented Apr 24, 2025

New modules added. +new content

Asciidoc conversion for metrics-utilities docs (Ch 11 in configuring automation execution)

https://issues.redhat.com/browse/AAP-44185

@ianf77 ianf77 added Controller Content applies to automation controller 2.5 Content applies to AAP 2.5 Needs backport to 2.5 Changes still need to be applied to the AAP 2.5 branch labels Apr 24, 2025
@ianf77 ianf77 requested a review from michellemacrh April 25, 2025 09:20
ianf77 added 3 commits April 28, 2025 08:25
New modules added. +new content

Asciidoc conversion for metrics-utilities docs (Ch 11 in configuring automation execution)

https://issues.redhat.com/browse/AAP-44185
Corrections

Asciidoc conversion for metrics-utilities docs (Ch 11 in configuring automation execution)

https://issues.redhat.com/browse/AAP-44185
Corrections

Asciidoc conversion for metrics-utilities docs (Ch 11 in configuring automation execution)

https://issues.redhat.com/browse/AAP-44185
Copy link
Contributor

@michellemacrh michellemacrh left a comment

Choose a reason for hiding this comment

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

Review completed - I noted a few build/formatting issues when building the docs locally and I may not have caught them all so would recommend doing a build to ensure everything renders correctly :)

ianf77 added 4 commits April 28, 2025 11:57
Corrections from review

Asciidoc conversion for metrics-utilities docs (Ch 11 in configuring automation execution)

https://issues.redhat.com/browse/AAP-44185
Correction

Asciidoc conversion for metrics-utilities docs (Ch 11 in configuring automation execution)

https://issues.redhat.com/browse/AAP-44185
Corrections

Asciidoc conversion for metrics-utilities docs (Ch 11 in configuring automation execution)

https://issues.redhat.com/browse/AAP-44185
Correction

Asciidoc conversion for metrics-utilities docs (Ch 11 in configuring automation execution)

https://issues.redhat.com/browse/AAP-44185

The {PlatformNameShort} metrics utility tool (`metrics-utility`) is a command-line utility that is installed on a system containing an instance of {ControllerName}.

When installed and configured, `metrics-utility` gathers billing-related metrics from your system and creates a consumption-based billing report. Metrics-utility is especially suited for users who have multiple managed hosts and want to use consumption-based billing. Once a report is generated, it is deposited in a target location that you specify in the configuration file.
When installed and configured, `metrics-utility` gathers billing-related metrics from your system and creates a consumption-based billing report. The `metrics-utility` tool is especially suited for users who have multiple managed hosts and want to use consumption-based billing. Once a report is generated, it is deposited in a target location that you specify in the configuration file.
Copy link
Contributor

Choose a reason for hiding this comment

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

I recommend using "after" instead of "once" it's clearer and less ambiguous for translation and non native speakers

+
`metrics-utility build_report`

. The generated report will have the default name `CCSP-<YEAR>-<MONTH>.xlsx` and is located in the ship path that you specified in step 2.
Copy link
Contributor

Choose a reason for hiding this comment

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

Active voice suggestion: "The system saves the generated report as CCSP--.xlsx in the ship path you specified in step 2."

.Procedure
. From the navigation panel, select menu::ConfigMaps[].
. Click btn:[Create ConfigMap].
. On the next screen, select the YAML view tab.
Copy link
Contributor

Choose a reason for hiding this comment

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

When I was reviewing the build I noticed this is bolded, but there's no bold syntax here? Weird?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No idea!!

And there's also a line missing!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It seems to consistently bold YAML.

----
scp -r username@controller_host:$METRICS_UTILITY_SHIP_PATH/data/<YYYY>/<MM>/ /local/directory/
----
The generated report will have the default name `CCSP-<YEAR>-<MONTH>.xlsx` and is located in the ship path that you specified.
Copy link
Contributor

Choose a reason for hiding this comment

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

Active voice suggestion: "The system saves the generated report as CCSP--.xlsx in the ship path you specified"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.5 Content applies to AAP 2.5 Controller Content applies to automation controller Needs backport to 2.5 Changes still need to be applied to the AAP 2.5 branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants