blob: 419354b2d8e6c5c5a5e95930b9d1058002f7cc3c [file] [log] [blame]
{"component":{"kind":"component","name":"micrometer","title":"Micrometer","description":"Collect various metrics directly from Camel routes using the Micrometer library.","deprecated":false,"firstVersion":"2.22.0","label":"monitoring","javaType":"org.apache.camel.component.micrometer.MicrometerComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-micrometer","version":"3.18.1","scheme":"micrometer","extendsScheme":"","syntax":"micrometer: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.micrometer.MicrometerTimerAction","enum":["start","stop"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override timer action in URI","constantName":"org.apache.camel.component.micrometer.MicrometerConstants#HEADER_TIMER_ACTION"},"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.micrometer.MicrometerConstants#HEADER_HISTOGRAM_VALUE"},"CamelMetricsCounterDecrement":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override decrement value in URI","constantName":"org.apache.camel.component.micrometer.MicrometerConstants#HEADER_COUNTER_DECREMENT"},"CamelMetricsCounterIncrement":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Double","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override increment value in URI","constantName":"org.apache.camel.component.micrometer.MicrometerConstants#HEADER_COUNTER_INCREMENT"},"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.micrometer.MicrometerConstants#HEADER_METRIC_NAME"},"CamelMetricsTags":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.Iterable<Tag>","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"To augment meter tags defined as URI parameters","constantName":"org.apache.camel.component.micrometer.MicrometerConstants#HEADER_METRIC_TAGS"}},"properties":{"metricsType":{"kind":"path","displayName":"Metrics Type","group":"producer","label":"","required":true,"type":"object","javaType":"io.micrometer.core.instrument.Meter.Type","enum":["counter","distribution_summary","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"},"tags":{"kind":"path","displayName":"Tags","group":"producer","label":"","required":false,"type":"object","javaType":"java.lang.Iterable<io.micrometer.core.instrument.Tag>","deprecated":false,"autowired":false,"secret":false,"description":"Tags of metrics"},"action":{"kind":"parameter","displayName":"Action","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Action expression when using timer type"},"decrement":{"kind":"parameter","displayName":"Decrement","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Decrement value expression when using counter type"},"increment":{"kind":"parameter","displayName":"Increment","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Increment value expression when using counter type"},"value":{"kind":"parameter","displayName":"Value","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Value expression 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."}}}