{"id":15663975,"url":"https://github.com/chappio/directus-extension-prometheus","last_synced_at":"2025-05-05T23:49:33.162Z","repository":{"id":65766049,"uuid":"599273325","full_name":"ChappIO/directus-extension-prometheus","owner":"ChappIO","description":"Expose metrics about your data through prometheus","archived":false,"fork":false,"pushed_at":"2024-02-28T07:28:43.000Z","size":120,"stargazers_count":17,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-30T15:18:09.826Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ChappIO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-08T20:02:27.000Z","updated_at":"2024-06-25T07:11:21.000Z","dependencies_parsed_at":"2024-01-15T06:02:12.152Z","dependency_job_id":"75da65e0-bf75-4cef-9b69-a8d9b9d2c2fa","html_url":"https://github.com/ChappIO/directus-extension-prometheus","commit_stats":{"total_commits":15,"total_committers":1,"mean_commits":15.0,"dds":0.0,"last_synced_commit":"3196087f647aa90adc761af15633ff6d26f63afa"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChappIO%2Fdirectus-extension-prometheus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChappIO%2Fdirectus-extension-prometheus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChappIO%2Fdirectus-extension-prometheus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ChappIO%2Fdirectus-extension-prometheus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ChappIO","download_url":"https://codeload.github.com/ChappIO/directus-extension-prometheus/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252596366,"owners_count":21773843,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-03T13:40:40.865Z","updated_at":"2025-05-05T23:49:33.142Z","avatar_url":"https://github.com/ChappIO.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Directus Extension: Prometheus\n\nExpose directus metrics to your prometheus instance.\n\nNo configuration required.\n\n## Install into your project\n\n```bash\nnpm install directus-extension-prometheus\n```\n\nNow, when you launch your directus instance, you will receive\nmetrics on the /metrics endpoint.\n\n## Optional Configuration\n\n\n| Option                        | Description                                               | Default      |\n|-------------------------------|-----------------------------------------------------------|--------------|\n| `PROMETHEUS_METRICS_ENDPOINT` | The endpoint on which the prometheus metrics are exposed. | `\"/metrics\"` |\n\n## Default Metrics\n\nHere is an example of the types of metrics exposed by this extension:\n\n```\n# HELP directus_request_count The total number of http requests\n# TYPE directus_request_count counter\ndirectus_request_count{status=\"200\",method=\"GET\"} 160\ndirectus_request_count{status=\"200\",method=\"POST\"} 2\ndirectus_request_count{status=\"304\",method=\"GET\"} 12\ndirectus_request_count{status=\"204\",method=\"PATCH\"} 5\n\n# HELP directus_request_duration_seconds The total duration of http requests\n# TYPE directus_request_duration_seconds histogram\ndirectus_request_duration_seconds_bucket{le=\"0.005\",method=\"GET\",status=\"200\"} 10\ndirectus_request_duration_seconds_bucket{le=\"0.01\",method=\"GET\",status=\"200\"} 57\ndirectus_request_duration_seconds_bucket{le=\"0.025\",method=\"GET\",status=\"200\"} 141\ndirectus_request_duration_seconds_bucket{le=\"0.05\",method=\"GET\",status=\"200\"} 158\ndirectus_request_duration_seconds_bucket{le=\"0.1\",method=\"GET\",status=\"200\"} 160\ndirectus_request_duration_seconds_bucket{le=\"0.25\",method=\"GET\",status=\"200\"} 160\ndirectus_request_duration_seconds_bucket{le=\"0.5\",method=\"GET\",status=\"200\"} 160\ndirectus_request_duration_seconds_bucket{le=\"1\",method=\"GET\",status=\"200\"} 160\ndirectus_request_duration_seconds_bucket{le=\"2.5\",method=\"GET\",status=\"200\"} 160\ndirectus_request_duration_seconds_bucket{le=\"5\",method=\"GET\",status=\"200\"} 160\ndirectus_request_duration_seconds_bucket{le=\"10\",method=\"GET\",status=\"200\"} 160\ndirectus_request_duration_seconds_bucket{le=\"+Inf\",method=\"GET\",status=\"200\"} 160\ndirectus_request_duration_seconds_sum{method=\"GET\",status=\"200\"} 2.239873104999999\ndirectus_request_duration_seconds_count{method=\"GET\",status=\"200\"} 160\ndirectus_request_duration_seconds_bucket{le=\"0.005\",method=\"POST\",status=\"200\"} 0\ndirectus_request_duration_seconds_bucket{le=\"0.01\",method=\"POST\",status=\"200\"} 0\ndirectus_request_duration_seconds_bucket{le=\"0.025\",method=\"POST\",status=\"200\"} 1\ndirectus_request_duration_seconds_bucket{le=\"0.05\",method=\"POST\",status=\"200\"} 1\ndirectus_request_duration_seconds_bucket{le=\"0.1\",method=\"POST\",status=\"200\"} 2\ndirectus_request_duration_seconds_bucket{le=\"0.25\",method=\"POST\",status=\"200\"} 2\ndirectus_request_duration_seconds_bucket{le=\"0.5\",method=\"POST\",status=\"200\"} 2\ndirectus_request_duration_seconds_bucket{le=\"1\",method=\"POST\",status=\"200\"} 2\ndirectus_request_duration_seconds_bucket{le=\"2.5\",method=\"POST\",status=\"200\"} 2\ndirectus_request_duration_seconds_bucket{le=\"5\",method=\"POST\",status=\"200\"} 2\ndirectus_request_duration_seconds_bucket{le=\"10\",method=\"POST\",status=\"200\"} 2\ndirectus_request_duration_seconds_bucket{le=\"+Inf\",method=\"POST\",status=\"200\"} 2\ndirectus_request_duration_seconds_sum{method=\"POST\",status=\"200\"} 0.08861785999999999\ndirectus_request_duration_seconds_count{method=\"POST\",status=\"200\"} 2\ndirectus_request_duration_seconds_bucket{le=\"0.005\",method=\"GET\",status=\"304\"} 0\ndirectus_request_duration_seconds_bucket{le=\"0.01\",method=\"GET\",status=\"304\"} 6\ndirectus_request_duration_seconds_bucket{le=\"0.025\",method=\"GET\",status=\"304\"} 11\ndirectus_request_duration_seconds_bucket{le=\"0.05\",method=\"GET\",status=\"304\"} 12\ndirectus_request_duration_seconds_bucket{le=\"0.1\",method=\"GET\",status=\"304\"} 12\ndirectus_request_duration_seconds_bucket{le=\"0.25\",method=\"GET\",status=\"304\"} 12\ndirectus_request_duration_seconds_bucket{le=\"0.5\",method=\"GET\",status=\"304\"} 12\ndirectus_request_duration_seconds_bucket{le=\"1\",method=\"GET\",status=\"304\"} 12\ndirectus_request_duration_seconds_bucket{le=\"2.5\",method=\"GET\",status=\"304\"} 12\ndirectus_request_duration_seconds_bucket{le=\"5\",method=\"GET\",status=\"304\"} 12\ndirectus_request_duration_seconds_bucket{le=\"10\",method=\"GET\",status=\"304\"} 12\ndirectus_request_duration_seconds_bucket{le=\"+Inf\",method=\"GET\",status=\"304\"} 12\ndirectus_request_duration_seconds_sum{method=\"GET\",status=\"304\"} 0.16695966899999998\ndirectus_request_duration_seconds_count{method=\"GET\",status=\"304\"} 12\ndirectus_request_duration_seconds_bucket{le=\"0.005\",method=\"PATCH\",status=\"204\"} 0\ndirectus_request_duration_seconds_bucket{le=\"0.01\",method=\"PATCH\",status=\"204\"} 4\ndirectus_request_duration_seconds_bucket{le=\"0.025\",method=\"PATCH\",status=\"204\"} 5\ndirectus_request_duration_seconds_bucket{le=\"0.05\",method=\"PATCH\",status=\"204\"} 5\ndirectus_request_duration_seconds_bucket{le=\"0.1\",method=\"PATCH\",status=\"204\"} 5\ndirectus_request_duration_seconds_bucket{le=\"0.25\",method=\"PATCH\",status=\"204\"} 5\ndirectus_request_duration_seconds_bucket{le=\"0.5\",method=\"PATCH\",status=\"204\"} 5\ndirectus_request_duration_seconds_bucket{le=\"1\",method=\"PATCH\",status=\"204\"} 5\ndirectus_request_duration_seconds_bucket{le=\"2.5\",method=\"PATCH\",status=\"204\"} 5\ndirectus_request_duration_seconds_bucket{le=\"5\",method=\"PATCH\",status=\"204\"} 5\ndirectus_request_duration_seconds_bucket{le=\"10\",method=\"PATCH\",status=\"204\"} 5\ndirectus_request_duration_seconds_bucket{le=\"+Inf\",method=\"PATCH\",status=\"204\"} 5\ndirectus_request_duration_seconds_sum{method=\"PATCH\",status=\"204\"} 0.059318456000000006\ndirectus_request_duration_seconds_count{method=\"PATCH\",status=\"204\"} 5\n\n# HELP directus_collection_size The total number of items in each collection\n# TYPE directus_collection_size gauge\ndirectus_collection_size{collection=\"directus_activity\"} 4\ndirectus_collection_size{collection=\"directus_collections\"} 1\ndirectus_collection_size{collection=\"directus_fields\"} 1\ndirectus_collection_size{collection=\"directus_files\"} 0\ndirectus_collection_size{collection=\"directus_folders\"} 0\ndirectus_collection_size{collection=\"directus_migrations\"} 62\ndirectus_collection_size{collection=\"directus_permissions\"} 0\ndirectus_collection_size{collection=\"directus_presets\"} 0\ndirectus_collection_size{collection=\"directus_relations\"} 0\ndirectus_collection_size{collection=\"directus_revisions\"} 2\ndirectus_collection_size{collection=\"directus_roles\"} 1\ndirectus_collection_size{collection=\"directus_sessions\"} 2\ndirectus_collection_size{collection=\"directus_settings\"} 0\ndirectus_collection_size{collection=\"directus_users\"} 1\ndirectus_collection_size{collection=\"directus_webhooks\"} 0\ndirectus_collection_size{collection=\"directus_dashboards\"} 0\ndirectus_collection_size{collection=\"directus_panels\"} 0\ndirectus_collection_size{collection=\"directus_notifications\"} 0\ndirectus_collection_size{collection=\"directus_shares\"} 0\ndirectus_collection_size{collection=\"directus_flows\"} 0\ndirectus_collection_size{collection=\"directus_operations\"} 0\ndirectus_collection_size{collection=\"thing\"} 0\n```\n\n## Adding Your Own Metrics\n\nTo add your own metrics, you have to [create an extension](https://docs.directus.io/extensions/creating-extensions.html).\nMost likely you'd want to create a hook extension but `directus-extension-prometheus` should be available from any api extension.\n\nUsage:\n\n```javascript\nconst {globalRegister} = require('directus-extension-prometheus');\nconst {Counter} = require(\"prom-client\");\n\nmodule.exports = {\n    default: ({init}) =\u003e {\n        // here I use the app.before hook to register this metric as soon as the app starts\n        init('app.before', () =\u003e {\n            const count = new Counter({\n                registers: [globalRegister],\n                name: 'timey_wimey',\n                help: 'People assume that time is a strict progression from cause to effect, but actually from a non-linear, non-subjective viewpoint, it’s more like a big ball of wibbly-wobbly, timey-wimey stuff.'\n            });\n\n            // increment the counter every second\n            setInterval(() =\u003e {\n                count.inc();\n            }, 1000);\n        });\n    }\n}\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchappio%2Fdirectus-extension-prometheus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchappio%2Fdirectus-extension-prometheus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchappio%2Fdirectus-extension-prometheus/lists"}