Github user keith-turner commented on a diff in the pull request:
    --- Diff: docs/ ---
    @@ -1,69 +1,112 @@
     # Fluo Metrics
    -Fluo core is instrumented using [dropwizard metrics][1]. This allows fluo 
users to easily gather
    -information about Fluo by configuring different reporters. While 
dropwizard can be configured to
    -report Fluo metrics to many different tools, below are some tools that 
have been used with Fluo.
    +A Fluo application can be configured (in []) to report 
metrics. When metrics are 
    +configured, Fluo will report will some 'default' metrics about an 
application that helps users 
    +monitor its performance. Users can also write code to report 'application' 
metrics from their
    +applications. Both 'application' and 'default' metrics share the same 
reporter configured by 
    +[] and are described in detail below.
    -1.  [Grafana/InfluxDB][3] - Fluo has [documentation][3] for sending 
metrics to InfluxDB and viewing
    -    them in Grafana.
    +## Configuring reporters
    -2.  JMX - Fluo can be configured to reports metrics via JMX which can be 
viewed in jconsole or
    -    jvisualvm.
    +Fluo metrics are not published by default. To publish metrics, configure a 
reporter in the 'metrics'
    +section of []. There are several different reporter types 
(i.e Console, CSV, 
    +Graphite, JMX, SLF4J) that are implemented using [Dropwizard]. The choice 
of which reporter to use
    +depends on the visualization tool used. If you are not currently using a 
visualization tool, there
    +is [documentation][grafana] for reporting Fluo metrics to Grafana/InfluxDB.
    -3.  CSV - Fluo can be configured to output metrics as CSV to a specified 
    +## Metrics names
    -## Configuring Reporters
    +When Fluo metrics are reported, they are published using a naming scheme 
that encodes additional
    -In order to configure metrics reporters, look at the metrics section in an 
    -`` file. This sections has a lot of commented out options 
for configuring reporters.
    +Default metrics start with `fluo.class` or `fluo.system` and have 
following naming schemes:
    -    fluo.metrics.reporter.console.enable=false
    -    fluo.metrics.reporter.console.frequency=30
    --- End diff --
    To be consistent w/ rest of document seems like this should be
    Or could remove use of less than and greater than in the rest of the 
document.  Should probably explain the convention used for things that vary not 
matter how its done. 
    Could use a convention that things in *italics* vary like: 
fluo.class.*application*.*reporter_id*.*metrics*.*class* . Maybe thats too 

If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at or file a JIRA ticket
with INFRA.

Reply via email to