Skip to content

Latest commit

 

History

History
26 lines (17 loc) · 1.2 KB

CONTRIBUTING.adoc

File metadata and controls

26 lines (17 loc) · 1.2 KB

Contributing to Hawkular Metrics

Before contributing to Hawkular Metrics, it might be useful to read the How to develop on Hawkular page on Hawkular website.

Code style

Hawkular Metrics is a Hawkular subproject, so top level conventions apply here. That said, there are some Metrics specific ones.

Logging

When working with the JBoss Logging API:

  • Group all INFO level and above messages in one interface per logical module for maintainability

  • Instead of creating a logger instance in the message logger interface, use a helper class to get a logger instance with proper category

  • Use existing message logger instance to log trace/debug messages instead of creating a separate logger instance

The logging projectCode is HAWKMETRICS.

Note that until we no longer need to support EAP 6.4, we must not use primitive arguments in logging method calls.

Logback is the logging backend for tests. It allows to set log level with a system property while still having a default value. No Maven filtering/replace dance involved.