This Confluence has been LDAP enabled, if you are an ASF Committer, please use your LDAP Credentials to login. Any problems file an INFRA jira ticket please.

Child pages
  • Metrics Component

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagetext
metrics:counter:metricname[?options]

Options

Name

Default

Description

increment

-

Long value to add to the counter

decrement

-

Long value to subtract from the counter

If neither increment or decrement is defined then counter value will be incremented by one. If increment and decrement are both defined only increment operation is called. 

...

Message headers can be used to override increment and decrement values specified in the metrics component URI.

Name

Description

Expected type

CamelMetricsCounterIncrement

Override increment value in URI

Long

CamelMetricsCounterDecrement

Override decrement value in URI

Long

Code Block
languagejava
// update counter simple.counter by 417
from("direct:in")
    .setHeader(MetricsConstants.HEADER_COUNTER_INCREMENT, constant(417L))
    .to("metric:counter:simple.counter?increment=7")
    .to("direct:out");

...

Code Block
languagetext
metrics:histogram:metricname[?options]

Options

Name

Default

Description

value

-

Value to use in histogram

If no value is not set nothing is added to histogram and warning is logged.

...

Message header can be used to override value specified in metrics component URI.

Name

Description

Expected type

CamelMetricsHistogramValue

Override histogram value in URI

Long

Code Block
languagejava
// Adds value 992 to simple.histogram
from("direct:in")
    .setHeader(MetricsConstants.HEADER_HISTOGRAM_VALUE, constant(992L))
    .to("metric:histogram:simple.histogram?value=700")
    .to("direct:out")

...

Code Block
languagetext
metrics:meter:metricname[?options]

Options

Name

Default

Description

mark

-

Long value to use as mark

If mark is not set then meter.mark() is called without argument.

...

Message header can be used to override mark value specified in metrics component URI.

Name

Description

Expected type

CamelMetricsMeterMark

Override mark value in URI

Long

Code Block
languagejava
// updates meter simple.meter with value 345
from("direct:in")
    .setHeader(MetricsConstants.HEADER_METER_MARK, constant(345L))
    .to("metric:meter:simple.meter?mark=123")
    .to("direct:out");

...

Code Block
languagetext
metrics:timer:metricname[?options]

Options

Name

Default

Description

action

-

start or stop

If no action or invalid value is provided then warning is logged without any timer update. If action start is called on already running timer or stop is called on not running timer then nothing is updated and warning is logged.

...

Message header can be used to override action value specified in metrics component URI.

Name

Description

Expected type

CamelMetricsTimerAction

Override timer action in URI

org.apache.camel.component.metrics.timer.TimerEndpoint.TimerAction

Code Block
languagejava
// sets timer action using header
from("direct:in")
    .setHeader(MetricsConstants.HEADER_TIMER_ACTION, TimerAction.start)
    .to("metric:timer:simple.timer")
    .to("direct:out");

...

The MetricsRoutePolicyFactory and MetricsRoutePolicy supports the following options:

Name

Default

Description

useJmx

false

Whether to report fine grained statistics to JMX by using the com.codahale.metrics.JmxReporter.

Notice that if JMX is enabled on CamelContext then a MetricsRegistryService mbean is enlisted under the services type in the JMX tree. That MBean has a single operation to output the statistics using JSON. Setting useJmx to true is only needed if you want fine grained MBeans per statistics type.

jmxDomain

org.apache.camel.metrics

The JMX domain name.

prettyPrint

false

Whether to use pretty print when outputting statistics in JSON format.

metricsRegistry

 

Allow to use a shared com.codahale.metrics.MetricRegistry. If one is not configured Camel will create a shared instance for use by the CamelContext.

rateUnit

TimeUnit.SECONDS

The unit to use for rate in the metrics reporter or when dumping the statistics as JSON.

durationUnit

TimeUnit.MILLISECONDS

The unit to use for duration in the metrics reporter or when dumping the statistics as JSON.

namePattern

##name##.##routeId##.##type##

Camel 2.17: The name pattern to use. Uses dot as separators, but you can change that. The values ##name##, ##routeId##, and ##type## will be replaced with actual value. Where ###name### is the name of the CamelContext. ###routeId### is the id of the route, where ###type### is the value of responses.

...

The following options is supported on the factory:

Name

Default

Description

useJmx

false

Whether to report fine grained statistics to JMX by using the com.codahale.metrics.JmxReporter.

Notice that if JMX is enabled on CamelContext then a MetricsRegistryService MBean is enlisted under the services type in the JMX tree. That MBean has a single operation to output the statistics using JSON. Setting useJmx to true is only needed if you want fine grained MBeans per statistics type.

jmxDomain

org.apache.camel.metrics

The JMX domain name.

prettyPrint

false

Whether to use pretty print when outputting statistics in JSON format.

metricsRegistry

 

Allow to use a shared com.codahale.metrics.MetricRegistry. If one is not provided Camel will create a shared instance for use by the CamelContext.

rateUnit

TimeUnit.SECONDS

The unit to use for rate in the metrics reporter or when dumping the statistics as JSON.

durationUnit

TimeUnit.MILLISECONDS

The unit to use for duration in the metrics reporter or when dumping the statistics as JSON

namePattern

##name##.##routeId##.###id###.##type##

The name pattern to use. Uses dot as separators, but you can change that. The values ##name##, ##routeId##, ##type##, and ###id### will be replaced with actual value. Where ###name### is the name of the CamelContext.###routeId### is the name of the route. The ###id### pattern represents the node id, where ###type### is the value of history.

At runtime the metrics can be accessed from Java API or JMX which allows to gather the data as JSON output.

...