{"id":27040425,"url":"https://github.com/ldb/ultracdn-exporter","last_synced_at":"2025-04-05T03:29:11.911Z","repository":{"id":55671844,"uuid":"168395120","full_name":"ldb/ultracdn-exporter","owner":"ldb","description":"A Prometheus exporter for Leaseweb UltraCDN Metrics.","archived":false,"fork":false,"pushed_at":"2020-12-13T22:16:06.000Z","size":28,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":0,"default_branch":"master","last_synced_at":"2023-03-21T20:38:09.892Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ldb.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-01-30T18:41:32.000Z","updated_at":"2020-12-13T22:16:09.000Z","dependencies_parsed_at":"2022-08-15T06:10:15.484Z","dependency_job_id":null,"html_url":"https://github.com/ldb/ultracdn-exporter","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ldb%2Fultracdn-exporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ldb%2Fultracdn-exporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ldb%2Fultracdn-exporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ldb%2Fultracdn-exporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ldb","download_url":"https://codeload.github.com/ldb/ultracdn-exporter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247284910,"owners_count":20913691,"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":"2025-04-05T03:29:11.347Z","updated_at":"2025-04-05T03:29:11.895Z","avatar_url":"https://github.com/ldb.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ultracdn-exporter\n\nA Prometheus exporter for Leaseweb UltraCDN Metrics.\n\nAPI Specification can be found [here](https://portal.leasewebultracdn.com/apidoc.html).\n\n## Metrics\n\nThe exporter exports the following metrics for each distribution group:\n\n| name                | unit | description |\n|---------------------|:----:|:-----------:|\n|leaseweb_ultracdn_delivered_bytes       |bytes |Total number of bytes delivered in the last 5 minutes.        |\n|leaseweb_ultracdn_requests_total        |total |Total number of requests received in the last 5 minutes.      |\n|leaseweb_ultracdn_bandwidth_per_second_bytes         |B/s   |Total bandwidth per second summarized over the last 5 minutes.|\n|leaseweb_ultracdn_cachehits_per_requests_ratio    |total |Ratio of cachehits per requests in the last 5 minutes.        |\n|leaseweb_ultracdn_status_2xx_total |total |Total number of 2xx status codes sent in the last 5 minutes.  |\n|leaseweb_ultracdn_status_4xx_total |total |Total number of 4xx status codes sent in the last 5 minutes.  |\n|leaseweb_ultracdn_status_5xx_total |total |Total number of 5xx status codes sent in the last 5 minutes.  |\n\nEach metric is exported with `distribution_group` and `distribution_group_id` as labels.\n\n## Configuration\n\nThe exporter expects username and password for an UltraCDN account with read permissions to be passed via environment variables. Additonally, a port can be chosen:\n\n| ENV | value | default |\n|-----|:-------|:-------:|\n|USERNAME | account username | _none_ |\n|PASSWORD | account password | _none_ |\n|PORT     | port to listen on| 9666   |\n|TIMESTAMP_METRICS| add timestamp of datapoint to metrics | \"false\"|\n\n## Usage\n\nSimply point Prometheus to scrape from `host:port/metrics`.  \nIt does not make sense to scrape more frequently than 5 minutes, as new metrics will only be available in 5 minute intervals from UltraCDN.  \nNote that all metrics will have a lag of ~20 minutes, as metrics are not available earlier from UltraCDN.\nSince Prometheus usually does not accept too old metrics, they are not timestamped either with the correct time for the value. \nIf you want the original timestamps of datapoints to be exported to Prometheus, set the environment variable `TIMESTAMP_METRICS=true` when running the exporter.\nBe warned that, depending on configuration, Prometheus may chose to not ingest the metrics in that case.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fldb%2Fultracdn-exporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fldb%2Fultracdn-exporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fldb%2Fultracdn-exporter/lists"}