| {"component":{"kind":"component","name":"microprofile-metrics","title":"MicroProfile Metrics","description":"Expose metrics from Camel routes.","deprecated":false,"firstVersion":"3.0.0","label":"monitoring","javaType":"org.apache.camel.component.microprofile.metrics.MicroProfileMetricsComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-microprofile-metrics","version":"3.18.1","scheme":"microprofile-metrics","extendsScheme":"","syntax":"microprofile-metrics:metricType:metricName","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false},"headers":{"CamelMicroProfileMetricsCounterIncrement":{"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.microprofile.metrics.MicroProfileMetricsConstants#HEADER_COUNTER_INCREMENT"},"CamelMicroProfileMetricsGaugeIncrement":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override gaugeIncrement value from the URI","constantName":"org.apache.camel.component.microprofile.metrics.MicroProfileMetricsConstants#HEADER_GAUGE_INCREMENT"},"CamelMicroProfileMetricsGaugeDecrement":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override gaugeDecrement value from the URI","constantName":"org.apache.camel.component.microprofile.metrics.MicroProfileMetricsConstants#HEADER_GAUGE_DECREMENT"},"CamelMicroProfileMetricsGaugeValue":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Number","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override gaugeValue value from the URI","constantName":"org.apache.camel.component.microprofile.metrics.MicroProfileMetricsConstants#HEADER_GAUGE_VALUE"},"CamelMicroProfileMetricsHistogramValue":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override histogram value from the URI","constantName":"org.apache.camel.component.microprofile.metrics.MicroProfileMetricsConstants#HEADER_HISTOGRAM_VALUE"},"CamelMicroProfileMetricsMeterMark":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"Long","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override meter mark value from the URI","constantName":"org.apache.camel.component.microprofile.metrics.MicroProfileMetricsConstants#HEADER_METER_MARK"},"CamelMicroProfileMetricsDescription":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The description within the metric metadata","constantName":"org.apache.camel.component.microprofile.metrics.MicroProfileMetricsConstants#HEADER_METRIC_DESCRIPTION"},"CamelMicroProfileMetricsDisplayName":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The display name within the metric metadata","constantName":"org.apache.camel.component.microprofile.metrics.MicroProfileMetricsConstants#HEADER_METRIC_DISPLAY_NAME"},"CamelMicroProfileMetricsName":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The name of the metric","constantName":"org.apache.camel.component.microprofile.metrics.MicroProfileMetricsConstants#HEADER_METRIC_NAME"},"CamelMicroProfileMetricsTags":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The tags of the metric","constantName":"org.apache.camel.component.microprofile.metrics.MicroProfileMetricsConstants#HEADER_METRIC_TAGS"},"CamelMicroProfileMetricsType":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.eclipse.microprofile.metrics.MetricType","enum":["concurrent gauge","counter","gauge","meter","histogram","timer","simple timer","invalid"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The type of the metric","constantName":"org.apache.camel.component.microprofile.metrics.MicroProfileMetricsConstants#HEADER_METRIC_TYPE"},"CamelMicroProfileMetricsUnits":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The metric unit within the metric metadata","constantName":"org.apache.camel.component.microprofile.metrics.MicroProfileMetricsConstants#HEADER_METRIC_UNIT"},"CamelMicroProfileMetricsTimerAction":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"org.apache.camel.component.microprofile.metrics.TimerAction","enum":["START","STOP"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Override time action from the URI","constantName":"org.apache.camel.component.microprofile.metrics.MicroProfileMetricsConstants#HEADER_TIMER_ACTION"}},"properties":{"metricType":{"kind":"path","displayName":"Metric Type","group":"producer","label":"","required":true,"type":"object","javaType":"org.eclipse.microprofile.metrics.MetricType","enum":["concurrent gauge","counter","gauge","meter","histogram","timer","simple timer","invalid"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Metric type"},"metricName":{"kind":"path","displayName":"Metric Name","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Metric name"},"action":{"kind":"parameter","displayName":"Action","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Action to use when using the timer type"},"counterIncrement":{"kind":"parameter","displayName":"Counter Increment","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"Increment value when using the counter type"},"description":{"kind":"parameter","displayName":"Description","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Metric description"},"displayName":{"kind":"parameter","displayName":"Display Name","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Metric display name"},"gaugeDecrement":{"kind":"parameter","displayName":"Gauge Decrement","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Decrement metric value when using concurrent gauge type"},"gaugeIncrement":{"kind":"parameter","displayName":"Gauge Increment","group":"producer","label":"","required":false,"type":"boolean","javaType":"java.lang.Boolean","deprecated":false,"autowired":false,"secret":false,"description":"Increment metric value when using the concurrent gauge type"},"gaugeValue":{"kind":"parameter","displayName":"Gauge Value","group":"producer","label":"","required":false,"type":"object","javaType":"java.lang.Number","deprecated":false,"autowired":false,"secret":false,"description":"Decrement metric value when using concurrent gauge 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 value to set when using the meter type"},"metricUnit":{"kind":"parameter","displayName":"Metric Unit","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Metric unit. See org.eclipse.microprofile.metrics.MetricUnits"},"tags":{"kind":"parameter","displayName":"Tags","group":"producer","label":"","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"description":"Comma delimited list of tags associated with the metric in the format tagName=tagValue"},"value":{"kind":"parameter","displayName":"Value","group":"producer","label":"","required":false,"type":"integer","javaType":"java.lang.Long","deprecated":false,"autowired":false,"secret":false,"description":"Value to set when using the 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."}}} |