Custom metrics not available in Prometheus

[guimou]

Describe the bug

Hi!
I used s2i to wrap a model with custom metrics. Those metrics seem to work fine as they are included when making a query:

curl -X POST -H 'Content-Type: application/json' -d '{"strData": "0.365194527642578,0.819750231339882,-0.5927999453145171,-0.619484351930421,-2.84752569239798,1.48432160780265,0.499518887687186,72.98"}' http://server-address/api/v1.0/predictions

{"data":{"names":[],"tensor":{"shape":[1],"values":[0]}},"meta":{"metrics":[{"key":"mycounter","type":"COUNTER","value":1},{"key":"mygauge","type":"GAUGE","value":100},{"key":"mytimer","type":"TIMER","value":20.2},{"key":"V3","type":"GAUGE","value":0.365194527642578},{"key":"V4","type":"GAUGE","value":0.819750231339882},{"key":"V10","type":"GAUGE","value":-0.5927999453145171},{"key":"V11","type":"GAUGE","value":-0.619484351930421},{"key":"V12","type":"GAUGE","value":-2.84752569239798},{"key":"V14","type":"GAUGE","value":1.48432160780265},{"key":"V17","type":"GAUGE","value":0.499518887687186},{"key":"Amount","type":"GAUGE","value":72.98},{"key":"proba_1","type":"GAUGE","value":0.05266069701605429}]}}

Also standard metrics (seldon_api_executor_server_requests_seconds_(bucket,count,sum) and seldon_api_executor_client_requests_seconds_(bucket,count,sum)) are correctly exported to Prometheus, and I can create the Seldon core Grafana dashboard.

However my custom metrics are nowhere to be found in the Prometheus endpoint (see output below). What do I miss? Are those metrics exported on a different endpoint (that I can not find...)?

Environment

• Cloud Provider: AWS
• Kubernetes Cluster Version: OpenShift 4.5.18, k8s 1.18.3
• Seldon operator 1.2.2

Metrics definition

    def metrics(self):
        return [
            {"type":"COUNTER","key":"mycounter","value":1}, # a counter which will increase by the given value
            {"type":"GAUGE","key":"mygauge","value":100}, # a gauge which will be set to given value
            {"type":"TIMER","key":"mytimer","value":20.2}, # a timer which will add sum and count metrics - assumed millisecs
            {"type":"GAUGE","key":"V3","value":self.V3},
            {"type":"GAUGE","key":"V4","value":self.V4},
            {"type":"GAUGE","key":"V10","value":self.V10},
            {"type":"GAUGE","key":"V11","value":self.V11},
            {"type":"GAUGE","key":"V12","value":self.V12},
            {"type":"GAUGE","key":"V14","value":self.V14},
            {"type":"GAUGE","key":"V17","value":self.V17},
            {"type":"GAUGE","key":"Amount","value":self.Amount},
            {"type":"GAUGE","key":"proba_1","value":self.proba_1[0]},
            ]

Output of Prometheus endpoint

http://server-endpoint/prometheus

# HELP go_gc_duration_seconds A summary of the pause duration of garbage collection cycles.
# TYPE go_gc_duration_seconds summary
go_gc_duration_seconds{quantile="0"} 1.4961e-05
go_gc_duration_seconds{quantile="0.25"} 1.6725e-05
go_gc_duration_seconds{quantile="0.5"} 2.0589e-05
go_gc_duration_seconds{quantile="0.75"} 3.5607e-05
go_gc_duration_seconds{quantile="1"} 0.000462769
go_gc_duration_seconds_sum 0.002212512
go_gc_duration_seconds_count 49
# HELP go_goroutines Number of goroutines that currently exist.
# TYPE go_goroutines gauge
go_goroutines 25
# HELP go_info Information about the Go environment.
# TYPE go_info gauge
go_info{version="go1.13.14"} 1
# HELP go_memstats_alloc_bytes Number of bytes allocated and still in use.
# TYPE go_memstats_alloc_bytes gauge
go_memstats_alloc_bytes 8.6562e+06
# HELP go_memstats_alloc_bytes_total Total number of bytes allocated, even if freed.
# TYPE go_memstats_alloc_bytes_total counter
go_memstats_alloc_bytes_total 1.80340624e+08
# HELP go_memstats_buck_hash_sys_bytes Number of bytes used by the profiling bucket hash table.
# TYPE go_memstats_buck_hash_sys_bytes gauge
go_memstats_buck_hash_sys_bytes 1.480127e+06
# HELP go_memstats_frees_total Total number of frees.
# TYPE go_memstats_frees_total counter
go_memstats_frees_total 1.070337e+06
# HELP go_memstats_gc_cpu_fraction The fraction of this program's available CPU time used by the GC since the program started.
# TYPE go_memstats_gc_cpu_fraction gauge
go_memstats_gc_cpu_fraction 2.837789735746736e-06
# HELP go_memstats_gc_sys_bytes Number of bytes used for garbage collection system metadata.
# TYPE go_memstats_gc_sys_bytes gauge
go_memstats_gc_sys_bytes 2.38592e+06
# HELP go_memstats_heap_alloc_bytes Number of heap bytes allocated and still in use.
# TYPE go_memstats_heap_alloc_bytes gauge
go_memstats_heap_alloc_bytes 8.6562e+06
# HELP go_memstats_heap_idle_bytes Number of heap bytes waiting to be used.
# TYPE go_memstats_heap_idle_bytes gauge
go_memstats_heap_idle_bytes 5.4738944e+07
# HELP go_memstats_heap_inuse_bytes Number of heap bytes that are in use.
# TYPE go_memstats_heap_inuse_bytes gauge
go_memstats_heap_inuse_bytes 1.0764288e+07
# HELP go_memstats_heap_objects Number of allocated objects.
# TYPE go_memstats_heap_objects gauge
go_memstats_heap_objects 26790
# HELP go_memstats_heap_released_bytes Number of heap bytes released to OS.
# TYPE go_memstats_heap_released_bytes gauge
go_memstats_heap_released_bytes 5.1249152e+07
# HELP go_memstats_heap_sys_bytes Number of heap bytes obtained from system.
# TYPE go_memstats_heap_sys_bytes gauge
go_memstats_heap_sys_bytes 6.5503232e+07
# HELP go_memstats_last_gc_time_seconds Number of seconds since 1970 of last garbage collection.
# TYPE go_memstats_last_gc_time_seconds gauge
go_memstats_last_gc_time_seconds 1.6076993224581149e+09
# HELP go_memstats_lookups_total Total number of pointer lookups.
# TYPE go_memstats_lookups_total counter
go_memstats_lookups_total 0
# HELP go_memstats_mallocs_total Total number of mallocs.
# TYPE go_memstats_mallocs_total counter
go_memstats_mallocs_total 1.097127e+06
# HELP go_memstats_mcache_inuse_bytes Number of bytes in use by mcache structures.
# TYPE go_memstats_mcache_inuse_bytes gauge
go_memstats_mcache_inuse_bytes 27776
# HELP go_memstats_mcache_sys_bytes Number of bytes used for mcache structures obtained from system.
# TYPE go_memstats_mcache_sys_bytes gauge
go_memstats_mcache_sys_bytes 32768
# HELP go_memstats_mspan_inuse_bytes Number of bytes in use by mspan structures.
# TYPE go_memstats_mspan_inuse_bytes gauge
go_memstats_mspan_inuse_bytes 105400
# HELP go_memstats_mspan_sys_bytes Number of bytes used for mspan structures obtained from system.
# TYPE go_memstats_mspan_sys_bytes gauge
go_memstats_mspan_sys_bytes 114688
# HELP go_memstats_next_gc_bytes Number of heap bytes when next garbage collection will take place.
# TYPE go_memstats_next_gc_bytes gauge
go_memstats_next_gc_bytes 1.5186864e+07
# HELP go_memstats_other_sys_bytes Number of bytes used for other system allocations.
# TYPE go_memstats_other_sys_bytes gauge
go_memstats_other_sys_bytes 3.261241e+06
# HELP go_memstats_stack_inuse_bytes Number of bytes in use by the stack allocator.
# TYPE go_memstats_stack_inuse_bytes gauge
go_memstats_stack_inuse_bytes 1.605632e+06
# HELP go_memstats_stack_sys_bytes Number of bytes obtained from system for stack allocator.
# TYPE go_memstats_stack_sys_bytes gauge
go_memstats_stack_sys_bytes 1.605632e+06
# HELP go_memstats_sys_bytes Number of bytes obtained from system.
# TYPE go_memstats_sys_bytes gauge
go_memstats_sys_bytes 7.4383608e+07
# HELP go_threads Number of OS threads created.
# TYPE go_threads gauge
go_threads 28
# HELP process_cpu_seconds_total Total user and system CPU time spent in seconds.
# TYPE process_cpu_seconds_total counter
process_cpu_seconds_total 5.15
# HELP process_max_fds Maximum number of open file descriptors.
# TYPE process_max_fds gauge
process_max_fds 1.048576e+06
# HELP process_open_fds Number of open file descriptors.
# TYPE process_open_fds gauge
process_open_fds 10
# HELP process_resident_memory_bytes Resident memory size in bytes.
# TYPE process_resident_memory_bytes gauge
process_resident_memory_bytes 5.054464e+07
# HELP process_start_time_seconds Start time of the process since unix epoch in seconds.
# TYPE process_start_time_seconds gauge
process_start_time_seconds 1.60769404043e+09
# HELP process_virtual_memory_bytes Virtual memory size in bytes.
# TYPE process_virtual_memory_bytes gauge
process_virtual_memory_bytes 2.117083136e+09
# HELP process_virtual_memory_max_bytes Maximum amount of virtual memory available in bytes.
# TYPE process_virtual_memory_max_bytes gauge
process_virtual_memory_max_bytes -1
# HELP promhttp_metric_handler_requests_in_flight Current number of scrapes being served.
# TYPE promhttp_metric_handler_requests_in_flight gauge
promhttp_metric_handler_requests_in_flight 1
# HELP promhttp_metric_handler_requests_total Total number of scrapes by HTTP status code.
# TYPE promhttp_metric_handler_requests_total counter
promhttp_metric_handler_requests_total{code="200"} 181
promhttp_metric_handler_requests_total{code="500"} 0
promhttp_metric_handler_requests_total{code="503"} 0
# HELP seldon_api_executor_client_requests_seconds A histogram of latencies for client calls from executor
# TYPE seldon_api_executor_client_requests_seconds histogram
seldon_api_executor_client_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",model_image="quay.io/odh-workshops/ccfd-business-workflow-tutorial-ccfd-modelfull",model_name="modelfull",model_version="1.1-CCFD",predictor_name="modelfull",predictor_version="",service="/predict",le="0.005"} 0
seldon_api_executor_client_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",model_image="quay.io/odh-workshops/ccfd-business-workflow-tutorial-ccfd-modelfull",model_name="modelfull",model_version="1.1-CCFD",predictor_name="modelfull",predictor_version="",service="/predict",le="0.01"} 0
seldon_api_executor_client_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",model_image="quay.io/odh-workshops/ccfd-business-workflow-tutorial-ccfd-modelfull",model_name="modelfull",model_version="1.1-CCFD",predictor_name="modelfull",predictor_version="",service="/predict",le="0.025"} 0
seldon_api_executor_client_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",model_image="quay.io/odh-workshops/ccfd-business-workflow-tutorial-ccfd-modelfull",model_name="modelfull",model_version="1.1-CCFD",predictor_name="modelfull",predictor_version="",service="/predict",le="0.05"} 0
seldon_api_executor_client_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",model_image="quay.io/odh-workshops/ccfd-business-workflow-tutorial-ccfd-modelfull",model_name="modelfull",model_version="1.1-CCFD",predictor_name="modelfull",predictor_version="",service="/predict",le="0.075"} 0
seldon_api_executor_client_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",model_image="quay.io/odh-workshops/ccfd-business-workflow-tutorial-ccfd-modelfull",model_name="modelfull",model_version="1.1-CCFD",predictor_name="modelfull",predictor_version="",service="/predict",le="0.1"} 0
seldon_api_executor_client_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",model_image="quay.io/odh-workshops/ccfd-business-workflow-tutorial-ccfd-modelfull",model_name="modelfull",model_version="1.1-CCFD",predictor_name="modelfull",predictor_version="",service="/predict",le="0.25"} 1301
seldon_api_executor_client_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",model_image="quay.io/odh-workshops/ccfd-business-workflow-tutorial-ccfd-modelfull",model_name="modelfull",model_version="1.1-CCFD",predictor_name="modelfull",predictor_version="",service="/predict",le="0.5"} 1305
seldon_api_executor_client_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",model_image="quay.io/odh-workshops/ccfd-business-workflow-tutorial-ccfd-modelfull",model_name="modelfull",model_version="1.1-CCFD",predictor_name="modelfull",predictor_version="",service="/predict",le="0.75"} 1305
seldon_api_executor_client_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",model_image="quay.io/odh-workshops/ccfd-business-workflow-tutorial-ccfd-modelfull",model_name="modelfull",model_version="1.1-CCFD",predictor_name="modelfull",predictor_version="",service="/predict",le="1"} 1305
seldon_api_executor_client_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",model_image="quay.io/odh-workshops/ccfd-business-workflow-tutorial-ccfd-modelfull",model_name="modelfull",model_version="1.1-CCFD",predictor_name="modelfull",predictor_version="",service="/predict",le="2.5"} 1305
seldon_api_executor_client_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",model_image="quay.io/odh-workshops/ccfd-business-workflow-tutorial-ccfd-modelfull",model_name="modelfull",model_version="1.1-CCFD",predictor_name="modelfull",predictor_version="",service="/predict",le="5"} 1305
seldon_api_executor_client_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",model_image="quay.io/odh-workshops/ccfd-business-workflow-tutorial-ccfd-modelfull",model_name="modelfull",model_version="1.1-CCFD",predictor_name="modelfull",predictor_version="",service="/predict",le="7.5"} 1305
seldon_api_executor_client_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",model_image="quay.io/odh-workshops/ccfd-business-workflow-tutorial-ccfd-modelfull",model_name="modelfull",model_version="1.1-CCFD",predictor_name="modelfull",predictor_version="",service="/predict",le="10"} 1305
seldon_api_executor_client_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",model_image="quay.io/odh-workshops/ccfd-business-workflow-tutorial-ccfd-modelfull",model_name="modelfull",model_version="1.1-CCFD",predictor_name="modelfull",predictor_version="",service="/predict",le="+Inf"} 1305
seldon_api_executor_client_requests_seconds_sum{code="200",deployment_name="modelfull",method="post",model_image="quay.io/odh-workshops/ccfd-business-workflow-tutorial-ccfd-modelfull",model_name="modelfull",model_version="1.1-CCFD",predictor_name="modelfull",predictor_version="",service="/predict"} 287.41634792999974
seldon_api_executor_client_requests_seconds_count{code="200",deployment_name="modelfull",method="post",model_image="quay.io/odh-workshops/ccfd-business-workflow-tutorial-ccfd-modelfull",model_name="modelfull",model_version="1.1-CCFD",predictor_name="modelfull",predictor_version="",service="/predict"} 1305
# HELP seldon_api_executor_server_requests_seconds A histogram of latencies for executor server
# TYPE seldon_api_executor_server_requests_seconds histogram
seldon_api_executor_server_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",predictor_name="modelfull",predictor_version="",service="predictions",le="0.005"} 0
seldon_api_executor_server_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",predictor_name="modelfull",predictor_version="",service="predictions",le="0.01"} 0
seldon_api_executor_server_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",predictor_name="modelfull",predictor_version="",service="predictions",le="0.025"} 0
seldon_api_executor_server_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",predictor_name="modelfull",predictor_version="",service="predictions",le="0.05"} 0
seldon_api_executor_server_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",predictor_name="modelfull",predictor_version="",service="predictions",le="0.075"} 0
seldon_api_executor_server_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",predictor_name="modelfull",predictor_version="",service="predictions",le="0.1"} 0
seldon_api_executor_server_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",predictor_name="modelfull",predictor_version="",service="predictions",le="0.25"} 1301
seldon_api_executor_server_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",predictor_name="modelfull",predictor_version="",service="predictions",le="0.5"} 1305
seldon_api_executor_server_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",predictor_name="modelfull",predictor_version="",service="predictions",le="0.75"} 1305
seldon_api_executor_server_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",predictor_name="modelfull",predictor_version="",service="predictions",le="1"} 1305
seldon_api_executor_server_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",predictor_name="modelfull",predictor_version="",service="predictions",le="2.5"} 1305
seldon_api_executor_server_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",predictor_name="modelfull",predictor_version="",service="predictions",le="5"} 1305
seldon_api_executor_server_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",predictor_name="modelfull",predictor_version="",service="predictions",le="7.5"} 1305
seldon_api_executor_server_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",predictor_name="modelfull",predictor_version="",service="predictions",le="10"} 1305
seldon_api_executor_server_requests_seconds_bucket{code="200",deployment_name="modelfull",method="post",predictor_name="modelfull",predictor_version="",service="predictions",le="+Inf"} 1305
seldon_api_executor_server_requests_seconds_sum{code="200",deployment_name="modelfull",method="post",predictor_name="modelfull",predictor_version="",service="predictions"} 287.7108624119998
seldon_api_executor_server_requests_seconds_count{code="200",deployment_name="modelfull",method="post",predictor_name="modelfull",predictor_version="",service="predictions"} 1305

[RafalSkolasinski]

Custom metrics are being exposed on each container, Prometheus needs to be configured properly in order to scrape them. In order to enable scraping from multiple container in single Pod it must be configured to use named ports, see documentation.

Also, custom metrics will be visible there only after first prediction request.

If you install seldon-core-analytics it should be already configured properly.

[guimou]

Thanks a lot! That's what I finally figured out.
I have my PodMonitor set in Prometheus now, and everything is working fine.
Thanks again, cheers!