Files
Wez Furlong d0278947ed docs: replace manual metrics docs with auto-generated ones
I factored out the sample outputs and used an include to pull
in that content.

In the future, we could automate creating those sample data files
based on the live instance, however, it will need some thought
as many metrics are instantiated dynamically.  That means that
simply launching the server to dump the initial counters could
miss a large number of the main production counters that are
the most interesting.  Likely we'll need something smarter than
that approach.  But that is an issue for the future!
2026-02-01 08:56:12 +00:00

114 lines
2.7 KiB
JSON

{
"connection_count": {
"help": "number of active connections",
"type": "gauge",
"value": {
"service": {
"esmtp_listener": 0.0,
"smtp_client": 0.0,
"smtp_client:source2->": 0.0
}
}
},
"scheduled_count": {
"help": "number of messages in the scheduled queue",
"type": "gauge",
"value": {
"queue": {
"example.com": 0.0
}
}
},
"lua_count": {
"help": "the number of lua contexts currently alive",
"type": "gauge",
"value": 1.0
},
"lua_load_count": {
"help": "how many times the policy lua script has been loaded into a new context",
"type": "counter",
"value": 1.0
},
"lua_spare_count": {
"help": "the number of lua contexts available for reuse in the pool",
"type": "gauge",
"value": 1.0
},
"memory_limit": {
"help": "soft memory limit measured in bytes",
"type": "gauge",
"value": 101234377728.0
},
"memory_usage": {
"help": "number of bytes of used memory",
"type": "gauge",
"value": 185683968.0
},
"message_count": {
"help": "total number of Message objects",
"type": "gauge",
"value": 1.0
},
"message_data_resident_count": {
"help": "total number of Message objects with body data loaded",
"type": "gauge",
"value": 1.0
},
"message_meta_resident_count": {
"help": "total number of Message objects with metadata loaded",
"type": "gauge",
"value": 1.0
},
"ready_count": {
"help": "number of messages in the ready queue",
"type": "gauge",
"value": {
"service": {
"smtp_client:source1->loopback.dummy-mx.example.com": 46.0,
"smtp_client:source2->loopback.dummy-mx.example.com": 152.0,
}
}
},
"total_connection_count": {
"help": "total number of active connections ever made",
"type": "counter",
"value": {
"service": {
"smtp_client": 0.0,
"smtp_client:source2->": 0.0
}
}
},
"total_messages_delivered": {
"help": "total number of messages ever delivered",
"type": "counter",
"value": {
"service": {
"smtp_client": 0.0,
"smtp_client:source2->": 0.0
}
}
},
"total_messages_fail": {
"help": "total number of message delivery attempts that permanently failed",
"type": "counter",
"value": {
"service": {
"smtp_client": 0.0,
"smtp_client:source2->": 0.0
}
}
},
"total_messages_transfail": {
"help": "total number of message delivery attempts that transiently failed",
"type": "counter",
"value": {
"service": {
"smtp_client": 0.0,
"smtp_client:source2->": 0.0
}
}
}
}