Difference between revisions of "Ceilometer/Contributing"
Rob-raymond (talk | contribs) (→Update documentation) |
(→Contributing to Ceilometer) |
||
| Line 1: | Line 1: | ||
= Contributing to Ceilometer = | = Contributing to Ceilometer = | ||
| − | The developer documentation is starting to take shape within the source and is also published at http://docs.openstack.org/developer/ceilometer/ | + | The developer documentation is starting to take shape within the source and is also published at http://docs.openstack.org/developer/ceilometer/. |
| − | The project team hangs out on Freenode in the #openstack- | + | The project team hangs out on Freenode in the #openstack-ceilometer channel, feel free to drop by and stay as long as you want. We use the [http://lists.openstack.org/pipermail/openstack-dev/ OpenStack Developers List] for our email discussions. If you want to make a post relevant to Ceilometer please tag the message subject with [Ceilometer]. |
| − | + | = Setting-up Ceilometer via devstack = | |
| − | |||
The easiest way to develop on Ceilometer is to use [http://devstack.org devstack]. | The easiest way to develop on Ceilometer is to use [http://devstack.org devstack]. | ||
| − | Edit your '' | + | Edit your ''local.conf'' file and add these lines to enable ''ceilometer'': |
<pre><nowiki>#!highlight bash | <pre><nowiki>#!highlight bash | ||
| − | enable_service ceilometer- | + | enable_service ceilometer-acompute ceilometer-acentral ceilometer-anotification ceilometer-collector ceilometer-api |
| − | + | enable_service ceilometer-alarm-notifier ceilometer-alarm-evaluator | |
| − | enable_service ceilometer- | ||
| − | |||
| + | # If you want to run the ceilometer api under apache with mod_wsgi uncomment the following | ||
| + | #CEILOMETER_USE_MOD_WSGI=True | ||
| + | # If you want to experiment with the polling coordination functionality uncomment one of the | ||
| + | # following coordination urls. | ||
| + | #CEILOMETER_COORDINATION_URL=memcached://localhost | ||
| + | #CEILOMETER_COORDINATION_URL=redis://localhost:6379 | ||
| + | # To speed up the polling interval (so you can see results more quickly use the following) | ||
| + | #CEILOMETER_PIPELINE_INTERVAL=30 | ||
| + | </nowiki></pre> | ||
| − | + | = Possible tasks = | |
| − | + | == Update documentation == | |
A good first step is to try following the documentation to set-up and configure Ceilometer to see if the documentation is wrong or out-dated. | A good first step is to try following the documentation to set-up and configure Ceilometer to see if the documentation is wrong or out-dated. | ||
Once everything's working, the next step would be to read the rest of the documentation to see if everything that's written is still true. Anything that's not clear or might be missing should be fixed and updated. | Once everything's working, the next step would be to read the rest of the documentation to see if everything that's written is still true. Anything that's not clear or might be missing should be fixed and updated. | ||
| Line 27: | Line 33: | ||
To update the documentation, the best way is to send a patch. But notifying the team via the [[MailingLists#Development_List|development mailing list]] or via IRC is fine too! | To update the documentation, the best way is to send a patch. But notifying the team via the [[MailingLists#Development_List|development mailing list]] or via IRC is fine too! | ||
| − | + | == Close old fixed bugs == | |
Old bugs are nasty. Even when they are long dead, they clog bug views and render the lists unusable. Just look at old bugs and check if they still apply! If they don't, close them as ''[[FixReleased]]'' (if you can pinpoint when they were fixed) or ''Invalid'' (if you can't). | Old bugs are nasty. Even when they are long dead, they clog bug views and render the lists unusable. Just look at old bugs and check if they still apply! If they don't, close them as ''[[FixReleased]]'' (if you can pinpoint when they were fixed) or ''Invalid'' (if you can't). | ||
| − | + | == Fix bugs == | |
The best thing you can do is to kill a living bug. Just look at the list of ''Confirmed'' or ''Triaged'' and pick your target. Submit a change that fixes it. Ask for review help on the channel. | The best thing you can do is to kill a living bug. Just look at the list of ''Confirmed'' or ''Triaged'' and pick your target. Submit a change that fixes it. Ask for review help on the channel. | ||
| − | + | == Review patches == | |
You can review patches on the Gerrit platform for [https://review.openstack.org/#/q/status:open+project:openstack/ceilometer,n,z ceilometer] and for [https://review.openstack.org/#/q/status:open+project:openstack/python-ceilometerclient,n,z python-ceilometerclient]. | You can review patches on the Gerrit platform for [https://review.openstack.org/#/q/status:open+project:openstack/ceilometer,n,z ceilometer] and for [https://review.openstack.org/#/q/status:open+project:openstack/python-ceilometerclient,n,z python-ceilometerclient]. | ||
| − | + | == Triage incoming bugs == | |
It's sometimes hard to distinguish fresh bugs from false alarms. You can help by using your expertise or reproduction skills on ''New'' bugs. If you can confirm the issue, set the bug to ''Confirmed''. If you can fix it, read the previous entry. If you need more info from the reporter, set it to ''Incomplete''. And if it happens to not really be valid, set it to ''Invalid''! | It's sometimes hard to distinguish fresh bugs from false alarms. You can help by using your expertise or reproduction skills on ''New'' bugs. If you can confirm the issue, set the bug to ''Confirmed''. If you can fix it, read the previous entry. If you need more info from the reporter, set it to ''Incomplete''. And if it happens to not really be valid, set it to ''Invalid''! | ||
You can read more information about [[BugTriage|how to do bug triaging for OpenStack]]. | You can read more information about [[BugTriage|how to do bug triaging for OpenStack]]. | ||
Revision as of 11:37, 27 October 2014
Contents
Contributing to Ceilometer
The developer documentation is starting to take shape within the source and is also published at http://docs.openstack.org/developer/ceilometer/.
The project team hangs out on Freenode in the #openstack-ceilometer channel, feel free to drop by and stay as long as you want. We use the OpenStack Developers List for our email discussions. If you want to make a post relevant to Ceilometer please tag the message subject with [Ceilometer].
Setting-up Ceilometer via devstack
The easiest way to develop on Ceilometer is to use devstack.
Edit your local.conf file and add these lines to enable ceilometer:
#!highlight bash enable_service ceilometer-acompute ceilometer-acentral ceilometer-anotification ceilometer-collector ceilometer-api enable_service ceilometer-alarm-notifier ceilometer-alarm-evaluator # If you want to run the ceilometer api under apache with mod_wsgi uncomment the following #CEILOMETER_USE_MOD_WSGI=True # If you want to experiment with the polling coordination functionality uncomment one of the # following coordination urls. #CEILOMETER_COORDINATION_URL=memcached://localhost #CEILOMETER_COORDINATION_URL=redis://localhost:6379 # To speed up the polling interval (so you can see results more quickly use the following) #CEILOMETER_PIPELINE_INTERVAL=30
Possible tasks
Update documentation
A good first step is to try following the documentation to set-up and configure Ceilometer to see if the documentation is wrong or out-dated. Once everything's working, the next step would be to read the rest of the documentation to see if everything that's written is still true. Anything that's not clear or might be missing should be fixed and updated.
To update the documentation, the best way is to send a patch. But notifying the team via the development mailing list or via IRC is fine too!
Close old fixed bugs
Old bugs are nasty. Even when they are long dead, they clog bug views and render the lists unusable. Just look at old bugs and check if they still apply! If they don't, close them as FixReleased (if you can pinpoint when they were fixed) or Invalid (if you can't).
Fix bugs
The best thing you can do is to kill a living bug. Just look at the list of Confirmed or Triaged and pick your target. Submit a change that fixes it. Ask for review help on the channel.
Review patches
You can review patches on the Gerrit platform for ceilometer and for python-ceilometerclient.
Triage incoming bugs
It's sometimes hard to distinguish fresh bugs from false alarms. You can help by using your expertise or reproduction skills on New bugs. If you can confirm the issue, set the bug to Confirmed. If you can fix it, read the previous entry. If you need more info from the reporter, set it to Incomplete. And if it happens to not really be valid, set it to Invalid!
You can read more information about how to do bug triaging for OpenStack.
