{"id":18525662,"url":"https://github.com/a-know/mackerel-remora","last_synced_at":"2025-04-09T12:31:20.588Z","repository":{"id":57555300,"uuid":"179048260","full_name":"a-know/mackerel-remora","owner":"a-know","description":"Remora, is agent for Mackerel ( mackerel.io ) to post service metrics","archived":false,"fork":false,"pushed_at":"2019-04-07T08:39:14.000Z","size":33,"stargazers_count":6,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-02T04:49:53.997Z","etag":null,"topics":["mackerel"],"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/a-know.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}},"created_at":"2019-04-02T09:52:32.000Z","updated_at":"2021-12-29T01:56:56.000Z","dependencies_parsed_at":"2022-09-14T11:01:49.146Z","dependency_job_id":null,"html_url":"https://github.com/a-know/mackerel-remora","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-know%2Fmackerel-remora","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-know%2Fmackerel-remora/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-know%2Fmackerel-remora/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/a-know%2Fmackerel-remora/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/a-know","download_url":"https://codeload.github.com/a-know/mackerel-remora/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248040259,"owners_count":21037838,"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":["mackerel"],"created_at":"2024-11-06T17:46:39.651Z","updated_at":"2025-04-09T12:31:15.577Z","avatar_url":"https://github.com/a-know.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mackerel-remora\nRemora is agent for Mackerel ( mackerel.io ) to post service metrics\n\n![remora](https://user-images.githubusercontent.com/1097533/55680852-4b7e2e00-595a-11e9-88c9-8624f3ff5332.png)\n\n## features\n\n- Post service metrics\n\n\n## How to use\nFor example, using `docker-compose` .\n\n```yml\nremora:\n  image: aknow/mackerel-remora:latest\n  volumes:\n      - .:/app\n  environment:\n    MACKEREL_REMORA_CONFIG: /app/_example/sample.yml\n```\n\n`sample.yml` is a config for `mackerel-remora` . The following is an example of its contents.\n\n```yml\napikey: xxxxx\nplugin:\n  servicemetrics:\n    demo:\n      sample:\n        command: sh /app/_example/demo.sh\n```\n\nAn example of the contents of `/app/_example/demo.sh` is:\n\n```sh\n#!/bin/sh\n\nmetric_name=\"demo.test_metric.number\"\n# metric number to post\nmetric=6\ndate=`date +%s`\n\necho \"${metric_name}\\t${metric}\\t${date}\"\n```\n\n\nIf you execute `docker-compose up -d remora` and wait for a while, it looks like on Mackerel:\n\n\u003cimg width=\"882\" src=\"https://user-images.githubusercontent.com/1097533/55680926-3b1a8300-595b-11e9-8576-9ba525750763.png\"\u003e\n\n\n## Config file format\n\n```yml\napibase: \u003capibase\u003e\napikey: \u003capikey\u003e\nroot: \u003crootdir\u003e\nplugin:\n  servicemetrics:\n    \u003cservicename\u003e:\n      \u003csettingname\u003e:\n        command: \u003ccommand\u003e\n        user: \u003cuser\u003e\n        env:\n          \u003cenvkey\u003e: \u003cenvvalue\u003e\n```\n\n\n- `\u003capibase\u003e`\n    - You can specify the domain of request destination API. It is usually unnecessary to specify.\n- `\u003capikey\u003e`\n    - API key issued by the Mackerel organization to which you are posting. Requires write permission.\n- `\u003croot\u003e`\n    - Root directory of mackerel-remora. It is usually unnecessary to specify.\n- `\u003cservicename\u003e`\n    - Destination service name. You need to create a service on Mackerel beforehand.\n- `\u003csettingname\u003e`\n    - Plugin setting name for posting service metrics. It should not be used, but should not be duplicated.\n- `\u003ccommand\u003e`\n    - A command to perform standard output expected as a service metric plug-in.\n    - Remora expect standard output in the format `{metric name}\\t{metric value}\\t{epoch seconds}` as a result of executing this command.\n- `\u003cuser\u003e`\n    - User of `command` running.\n- `\u003cenvkey\u003e`\n    - Variable name of the environment variable to pass to the `command` .\n- `\u003cenvvalue\u003e`\n    - Value of the environment variable to pass to the `command` .\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fa-know%2Fmackerel-remora","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fa-know%2Fmackerel-remora","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fa-know%2Fmackerel-remora/lists"}