{"id":20147394,"url":"https://github.com/kebe7jun/ropee","last_synced_at":"2025-04-09T19:36:05.338Z","repository":{"id":57500366,"uuid":"177700121","full_name":"kebe7jun/ropee","owner":"kebe7jun","description":"A scalable prometheus remote storage adapter for splunk.","archived":false,"fork":false,"pushed_at":"2023-02-15T03:19:09.000Z","size":91,"stargazers_count":58,"open_issues_count":6,"forks_count":6,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-06T07:41:36.703Z","etag":null,"topics":["daocloud","prometheus","remote-read","remote-write","splunk"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kebe7jun.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2019-03-26T02:28:21.000Z","updated_at":"2024-05-11T22:43:36.000Z","dependencies_parsed_at":"2023-10-14T23:22:42.225Z","dependency_job_id":"588218f3-c9da-4c6c-94e4-fc825c23edae","html_url":"https://github.com/kebe7jun/ropee","commit_stats":{"total_commits":33,"total_committers":2,"mean_commits":16.5,"dds":"0.030303030303030276","last_synced_commit":"83f0d094f57e46410a6e1edb4099d9ae4d9b5cb2"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kebe7jun%2Fropee","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kebe7jun%2Fropee/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kebe7jun%2Fropee/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kebe7jun%2Fropee/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kebe7jun","download_url":"https://codeload.github.com/kebe7jun/ropee/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248098412,"owners_count":21047435,"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":["daocloud","prometheus","remote-read","remote-write","splunk"],"created_at":"2024-11-13T22:28:51.579Z","updated_at":"2025-04-09T19:36:05.315Z","avatar_url":"https://github.com/kebe7jun.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ropee -- A prometheus remote storage adapter for splunk\n\n[![Build Status](https://travis-ci.org/kebe7jun/ropee.svg)](https://travis-ci.org/kebe7jun/ropee)\n[![codecov](https://codecov.io/gh/kebe7jun/ropee/branch/master/graph/badge.svg)](https://codecov.io/gh/kebe7jun/ropee)\n[![GolangCI](https://golangci.com/badges/github.com/kebe7jun/ropee.svg)](https://golangci.com/r/github.com/kebe7jun/ropee)\n\n\nWith this remote storage adapter, Prometheus can use Splunk as a long-term store for time-series metrics.\n\n\n## Docker instructions\n\nA docker image for the splunk storage adapter is available on Docker Hub at kebe/ropee.\n\n### Start with docker\n\n```console\n# You must edit the following command for your env.\n$ docker run -d --name ropee -p 9970:9970 \\\n    -e LISTEN_ADDR=0.0.0.0:9970 \\\n    -e SPLUNK_METRICS_INDEX=metrics \\\n    -e SPLUNK_METRICS_SOURCETYPE=DaoCloud_promu_metrics \\\n    -e SPLUNK_HEC_TOKEN=asddsa1-12312312-3123-2 \\\n    -e SPLUNK_HEC_URL=https://192.168.1.1:8088 \\\n    -e SPLUNK_URL=https://192.168.1.1:8089 \\\n    -e TIMEOUT=60 \\\n    -e DEBUG=0 \\\n    kebe/ropee:latest\n```\n\n### Command args\n```\nUsage of ./ropee:\n  -debug\n    \tDebug mode.\n  -listen-addr string\n    \tSopee listen addr. (default \"127.0.0.1:9970\")\n  -log-file-path string\n    \tLog files path. (default \"/var/log\")\n  -splunk-hec-token string\n    \tSplunk Http event collector token.\n  -splunk-hec-url string\n    \tSplunk Http event collector url. (default \"https://127.0.0.1:8088\")\n  -splunk-metrics-index string\n    \tIndex name. (default \"*\")\n  -splunk-metrics-sourcetype string\n    \tThe prometheus sourcetype name. (default \"DaoCloud_promu_metrics\")\n  -splunk-url string\n    \tSplunk Manage Url. (default \"https://127.0.0.1:8089\")\n  -timeout int\n    \tAPI timeout seconds. (default 60)\n```\n\n## Configuring Splunk\n\n### HEC(HTTP Event Collector)\nPlease follow splunk docs.\n\n### Add SourceType for prom metrics\n\nprops.conf\n\n```\n[DaoCloud_promu_metrics]\nDATETIME_CONFIG = CURRENT\nTRANSFORMS-prometheus_to_metric = prometheus_metric_name_value, prometheus_metric_dims\nNO_BINARY_CHECK = true\ndescription = Prometheus Metrics.\nSHOULD_LINEMERGE = false\npulldown_type = 1\ncategory = Metrics\n```\n\ntransforms.conf\n```\n[prometheus_metric_name_value]\nREGEX = ^([^\\s{]+)({[^}]+})? ([-+]?[0-9]*\\.?[0-9]+([eE][-+]?[0-9]+)?)\nFORMAT = metric_name::$1 ::$2 _value::$3\nWRITE_META = true\n\n[prometheus_metric_dims]\nREGEX = ([a-zA-Z_][a-zA-Z0-9_]*)=\"([^\"]*)\"[, ]*\nFORMAT = $1::\"$2\"\nREPEAT_MATCH = true\nWRITE_META = true\n```\n\n### Add a metric index\nPlease follow splunk docs.\n\n\n## Configuring Prometheus\n\n```\n...\nremote_read:\n  - url: \"http://127.0.0.1:9970/read\"\n# for remote read, you should set the basic auth which belongs splunk's user.\n\nremote_write:\n  - url: \"http://127.0.0.1:9970/write\"\n\n```\n\n### Building\n\n```\ngo mod download\ngo run main.go\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkebe7jun%2Fropee","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkebe7jun%2Fropee","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkebe7jun%2Fropee/lists"}