; Mon, 17 Jul 2017 04:19:24 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1015573 - in /websites/production/camel/content: cache/main.pageCache metrics-component.html Date: Mon, 17 Jul 2017 04:19:24 -0000 To: commits@camel.apache.org From: buildbot@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20170717041924.AD3D43A00E6@svn01-us-west.apache.org> archived-at: Mon, 17 Jul 2017 04:19:28 -0000 Author: buildbot Date: Mon Jul 17 04:19:24 2017 New Revision: 1015573 Log: Production update by buildbot for camel Modified: websites/production/camel/content/cache/main.pageCache websites/production/camel/content/metrics-component.html Modified: websites/production/camel/content/cache/main.pageCache ============================================================================== Binary files - no diff available. Modified: websites/production/camel/content/metrics-component.html ============================================================================== --- websites/production/camel/content/metrics-component.html (original) +++ websites/production/camel/content/metrics-component.html Mon Jul 17 04:19:24 2017 @@ -123,7 +123,7 @@ public static class MyConfig extends Sin .to("direct:out");]]>

will update counter with name new.name instead of name.not.used.

All metrics specific headers are removed from the message once Metrics endpoint finishes processing of exchange. While processing the exchange metrics endpoint any exceptions thrown are caught and written to as a log entry at level warn.

Metrics Type Counter

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 inc remented by one. If increment and decrement are both defined only increment operation is called.

Options

Name	Default	Description
`increment`	`-`	Long value to add to the counter
`decrement`	`-`	Long value to subtract from the counter

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

Headers

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 de crement value in URI	`Long`

Headers

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`

Metric type histogram

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.

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.

Headers

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

Name	Description	Expected type
`CamelMetricsHistogramValue`	Override histogram value in URI	`Long`

Headers

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

Name	Description	Expected type
`CamelMetricsHistogramValue`	Override histogram value in URI	`Long`

Metric type meter

Options

Name	Default	Description
`mark`	`-`	Long value to use as mark

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

Options

Name	Default	Description
`mark`	`-`	Long value to use as mark

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

Headers

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`

Headers

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`

Metrics type timer

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.

Options

Name	Default	Description
`action`	`-`	start or stop

TimerContext objects are stored as Exchange properties between different metrics component calls.

Headers

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`

TimerContext objects are stored as Exchange properties between different metrics component calls.

Headers

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`

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 si ngle 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.

In Java you can get the com.codahale.metrics.MetricRegistry from the org.apache.camel.component.metrics.routepolicy.MetricsRegistryService as shown below:

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 J MX 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`		All ow 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.

In Java you can get the com.codahale.metrics.MetricRegistry from the org.apache.camel.component.metrics.routepolicy.MetricsRegistryService as shown below:

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.

In Java, get the service from the CamelContext as shown:

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 `us eJmx` 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 prov ided 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.

In Java, get the service from the CamelContext as shown:

And the JMX API the MBean is registered in the type=services tree with name=MetricsMessageHistoryService.