Contributor Guide

In the Contributor Guide, you will find documented policies for developing with Ceilometer. This includes the processes we use for bugs, contributor onboarding, core reviewer memberships, and other procedural items.

Ceilometer follows the same workflow as other OpenStack projects. To start contributing to Ceilometer, please follow the workflow found here.

Bug tracker:

https://bugs.launchpad.net/ceilometer

Mailing list:

http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-discuss (prefix subjects with [Ceilometer] for faster responses)

Wiki:

https://wiki.openstack.org/wiki/Ceilometer

Code Hosting:

https://opendev.org/openstack/ceilometer/

Code Review:

https://review.opendev.org/#/q/status:open+project:openstack/ceilometer,n,z

Overview

• Overview
  • Objectives
  • Metering
• System Architecture
  • High-Level Architecture
  • Gathering the data
  • Processing the data
  • Storing/Accessing the data

Data Types

• Measurements
  • Existing meters
  • New measurements
• Events and Event Processing
  • Events vs. Samples
  • Event Structure
  • Events from Notifications
  • Building Notifications

Getting Started

• Installing development sandbox
  • Configuring devstack
• Running the Tests
• Guru Meditation Reports
  • Generating a GMR
  • Structure of a GMR
  • Adding Support for GMRs to New Executables
  • Extending the GMR

Development

• Writing Agent Plugins
  • Plugin Framework
  • Polling Agents
  • Notifications
• Ceilometer + Gnocchi Integration
  • Managing Resource Types