| {"component":{"kind":"component","name":"metrics","title":"Metrics","description":"Collect various metrics directly from Camel routes using the DropWizard metrics library.","deprecated":false,"firstVersion":"2.14.0","label":"monitoring","javaType":"org.apache.camel.component.metrics.MetricsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-metrics","version":"3.18.1","scheme":"metrics","extendsScheme":"","syntax":"metrics:metricsType:metricsName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false},"headers":{"CamelMetricsTimerAction":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.metrics.MetricsTimerAction","enum":["start","stop"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override timer action in URI","constantName":"org.apache.camel.component.metrics.MetricsConstants#HEADER_TIMER_ACTION"},"CamelMetricsMeterMark":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override mark value in URI","constantName":"org.apache.camel.component.metrics.MetricsConstants#HEADER_METER_MARK"},"CamelMetricsHistogramValue":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override histogram value in URI","constantName":"org.apache.camel.component.metrics.MetricsConstants#HEADER_HISTOGRAM_VALUE"},"CamelMetricsCounterDecrement":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override decrement value in URI","constantName":"org.apache.camel.component.metrics.MetricsConstants#HEADER_COUNTER_DECREMENT"},"CamelMetricsCounterIncrement":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override increment value in URI","constantName":"org.apache.camel.component.metrics.MetricsConstants#HEADER_COUNTER_INCREMENT"},"CamelMetricsGaugeSubject":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Object","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override subject value in URI","constantName":"org.apache.camel.component.metrics.MetricsConstants#HEADER_GAUGE_SUBJECT"},"CamelMetricsName":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override name value in URI","constantName":"org.apache.camel.component.metrics.MetricsConstants#HEADER_METRIC_NAME"}},"properties":{"metricsType":{"kind":"path","displayName":"Metrics Type","group":"producer","label":"","required":true,"type":"object","javaType":"org.apache.camel.component.metrics.MetricsType","enum":["gauge","counter","histogram","meter","timer"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Type of metrics"},"metricsName":{"kind":"path","displayName":"Metrics Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of metrics"},"action":{"kind":"parameter","displayName":"Action","group":"producer","label":"","required":false,"type":"object","javaType":"org.apache.camel.component.metrics.MetricsTimerAction","enum":["start","stop"],"deprecated":false,"autowired":false,"secret":false,"description":"Action when using timer type"},"decrement":{"kind":"parameter","displayName":"Decrement","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"Decrement value when using counter type"},"increment":{"kind":"parameter","displayName":"Increment","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"Increment value when using counter type"},"mark":{"kind":"parameter","displayName":"Mark","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"Mark when using meter type"},"subject":{"kind":"parameter","displayName":"Subject","group":"producer","label":"","required":false,"type":"object","javaType":"java.lang.Object","deprecated":false,"autowired":false,"secret":false,"description":"Subject value when using gauge type"},"value":{"kind":"parameter","displayName":"Value","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"Value value when using histogram type"},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing."}}} |