Bug 1473698 - [Doc][ceilometer] Add telemetry usage examples, describe alarm types.
Summary: [Doc][ceilometer] Add telemetry usage examples, describe alarm types.
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat OpenStack
Classification: Red Hat
Component: documentation
Version: 10.0 (Newton)
Hardware: Unspecified
OS: Unspecified
low
low
Target Milestone: ---
: 12.0 (Pike)
Assignee: Martin Lopes
QA Contact: Deepti Navale
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2017-07-21 12:42 UTC by KOSAL RAJ I
Modified: 2018-02-20 01:50 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-02-20 01:50:34 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description KOSAL RAJ I 2017-07-21 12:42:37 UTC
Description of problem:

Can we have telemetry example in downstream as well.

Please follow the following upstream doc,

https://docs.openstack.org/aodh/latest/admin/telemetry-alarms.html

Version-Release number of selected component (if applicable):
RHOSP 10

How reproducible:


Steps to Reproduce:
1.
2.
3.

Actual results:


Expected results:


Additional info:

Comment 1 Martin Lopes 2017-07-25 04:20:29 UTC
Reviewed the existing guide: https://access.redhat.com/documentation/en-us/red_hat_openstack_platform/10/html-single/logging_monitoring_and_troubleshooting_guide/#monitoring_using_the_telemetry_service

Identified a few gaps that should be documented:

* Describe alarm dimensioning
* Describe composite alarms
* Describe alarm types:
--type event
--type composite

These should be added to the OSP11 guide, and backported to OSP10, where appropriate.

Comment 2 Martin Lopes 2017-07-25 05:45:14 UTC
Identified use case in BZ#1467317.

Created draft text for `--type event`.

----
This alarm raises an event when a particular instance is shutdown:

aodh alarm create \
	 --type event \
	 --name instance_off \
	 --description 'event_instance_power_off' \
	 --event-type "compute.instance.power_off.*" \
	 --enable True \
	 --query "traits.instance_id=string::ac917539-fa21-42fb-bac6-c3a795f056e" \
	 --alarm-action 'log://' \
	 --ok-action 'log://' \
	 --insufficient-data-action 'log://' \
	 --resource-type instance
----

Comment 3 Martin Lopes 2017-07-26 01:35:47 UTC
also elaborate on -alarm-action options, such as a webhook URL

Comment 4 Martin Lopes 2017-07-27 02:40:01 UTC
Emailed questions to SME.

Comment 5 Martin Lopes 2017-08-02 05:46:04 UTC
Also update examples to use the `ge` operator, where appropriate.

Comment 6 Martin Lopes 2017-08-03 22:48:43 UTC
Update: don't cover composite alarms

Comment 9 Martin Lopes 2017-08-08 04:55:53 UTC
See also https://access.redhat.com/solutions/2953931

Comment 12 Martin Lopes 2017-11-16 04:44:12 UTC
See also https://access.redhat.com/solutions/2953041

Comment 14 Martin Lopes 2017-11-17 00:31:25 UTC
Adding in updates from tech review

Comment 18 Deepti Navale 2018-02-19 22:37:40 UTC
Hey Martin, 

Looks good overall. Included a couple of minor comments in gitlab. Feel free to merge once updated. 

-Deepti

Comment 19 Martin Lopes 2018-02-20 01:22:28 UTC
Added updates from peer review.


Note You need to log in before you can comment on or make changes to this bug.