Component docs
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/47ee7085 Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/47ee7085 Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/47ee7085 Branch: refs/heads/master Commit: 47ee708519b0e67ea978ce9edce46b1f8716fafb Parents: a69affc3 Author: Claus Ibsen <davscl...@apache.org> Authored: Sun Sep 4 09:34:35 2016 +0200 Committer: Claus Ibsen <davscl...@apache.org> Committed: Sun Sep 4 09:34:35 2016 +0200 ---------------------------------------------------------------------- .../src/main/docs/metrics-component.adoc | 41 ++++++++++++++++++++ 1 file changed, 41 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/47ee7085/components/camel-metrics/src/main/docs/metrics-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-metrics/src/main/docs/metrics-component.adoc b/components/camel-metrics/src/main/docs/metrics-component.adoc index 80f63d5..fd28672 100644 --- a/components/camel-metrics/src/main/docs/metrics-component.adoc +++ b/components/camel-metrics/src/main/docs/metrics-component.adoc @@ -44,6 +44,47 @@ URI format metrics:[ meter | counter | histogram | timer ]:metricname[?options] ---- +[[MetricsComponent-options]] +Options +^^^^^^^ + +// component options: START +The Metrics component supports 1 options which are listed below. + + + +{% raw %} +[width="100%",cols="2,1m,7",options="header"] +|======================================================================= +| Name | Java Type | Description +| metricRegistry | MetricRegistry | To use a custom configured MetricRegistry. +|======================================================================= +{% endraw %} +// component options: END + + +// endpoint options: START +The Metrics component supports 9 endpoint options which are listed below: + +{% raw %} +[width="100%",cols="2,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| metricsType | producer | | MetricsType | *Required* Type of metrics +| metricsName | producer | | String | *Required* Name of metrics +| action | producer | | MetricsTimerAction | Action when using timer type +| decrement | producer | | Long | Decrement value when using counter type +| increment | producer | | Long | Increment value when using counter type +| mark | producer | | Long | Mark when using meter type +| value | producer | | Long | Value value when using histogram type +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). +|======================================================================= +{% endraw %} +// endpoint options: END + + + [[MetricsComponent-registryMetricRegistry]] [[MetricsComponent-registry]]Metric Registry ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
