https://github.com/mackerelio/mkr
Command Line Tool for Mackerel
https://github.com/mackerelio/mkr
go mackerel mackerel-agent mkr
Last synced: about 1 month ago
JSON representation
Command Line Tool for Mackerel
- Host: GitHub
- URL: https://github.com/mackerelio/mkr
- Owner: mackerelio
- License: apache-2.0
- Created: 2014-10-26T08:21:00.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2026-02-03T01:51:47.000Z (5 months ago)
- Last Synced: 2026-02-03T15:54:10.084Z (5 months ago)
- Topics: go, mackerel, mackerel-agent, mkr
- Language: Go
- Homepage: https://github.com/mackerelio/mkr
- Size: 1.93 MB
- Stars: 114
- Watchers: 15
- Forks: 32
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
mkr
===
[][release]
[][actions]
[][godocs]
[release]: https://github.com/mackerelio/mkr/releases
[actions]: https://github.com/mackerelio/mkr/actions?workflow=Build
[godocs]: https://pkg.go.dev/github.com/mackerelio/mkr
mkr - Command Line Tool For Mackerel written in Go.
# DESCRIPTION
mkr is a command-line interface tool for the [Mackerel API](https://mackerel.io/api-docs/) written in Go.
mkr helps to automate tedious daily server operations to best leverage Mackerel's and Unix's tools.
mkr output format is JSON, so it can be filtered with a JSON processor such as [jq](http://stedolan.github.io/jq/).
# INSTALLATION
## apt / yum (for Linux)
### CentOS 7 (or later)
```bash
curl -fsSL https://mackerel.io/file/script/setup-yum-v2.sh | sh
yum install mkr
```
### Debian / Ubuntu
```bash
curl -fsSL https://mackerel.io/file/script/setup-apt-v2.sh | sh
apt-get install mkr
```
### Amazon Linux 2 LTS
```bash
curl -fsSL https://mackerel.io/file/script/amznlinux/setup-yum-v2.sh | sh
yum install mkr
```
### Amazon Linux
```bash
curl -fsSL https://mackerel.io/file/script/amznlinux/setup-yum.sh | sh
yum install mkr
```
## Homebrew (for macOS)
You can also install from the brew rule we maintain, but we don't officially support the environment.
```bash
brew tap mackerelio/mackerel-agent
brew install mkr
```
## Build from source
```bash
$ go install github.com/mackerelio/mkr@latest
```
# USAGE
First the MACKEREL_APIKEY environment variable must be set. It is not necessary to set the MACKEREL_APIKEY on hosts running [mackerel-agent](https://github.com/mackerelio/mackerel-agent). For more details, see below.
```bash
export MACKEREL_APIKEY=
```
## EXAMPLES
```
mkr status
{
"id": "2eQGEaLxiYU",
"name": "myproxy001",
"status": "standby",
"roleFullnames": [
"My-Service:proxy"
],
"isRetired": false,
"createdAt": "2014-11-15T21:41:00+09:00"
}
```
```
mkr hosts --service My-Service --role proxy
[
{
"id": "2eQGEaLxiYU",
"name": "myproxy001",
"status": "standby",
"roleFullnames": [
"My-Service:proxy"
],
"isRetired": false,
"createdAt": "2014-11-15T21:41:00+09:00"
},
{
"id": "2eQGDXqtoXs",
"name": "myproxy002",
"status": "standby",
"roleFullnames": [
"My-Service:proxy"
],
"isRetired": false,
"createdAt": "2014-11-15T21:41:00+09:00"
},
]
```
The format of `createdAt` uses ISO-8601 in the current time zone.
The `mkr hosts` command has an '-f' option to format the output.
```
mkr hosts -f '{{range .}}{{if (len .Interfaces)}}{{(index .Interfaces 0).IPAddress}}{{end}}{{"\t"}}{{.Name}}{{"\n"}}{{end}}'
10.0.1.1 myproxy001
10.0.1.2 myproxy002
...
```
```
mkr create --status working -R My-Service:db-master mydb001
mkr update --status maintenance --roleFullname My-Service:db-master
```
```
cat <
cat <
```
mkr fetch --name loadavg5 2eQGDXqtoXs
{
"2eQGDXqtoXs": {
"loadavg5": {
"time": 1416061500,
"value": 0.025
}
}
}
```
```
mkr retire ...
```
### Examples (on hosts running mackerel-agent)
Specifying the and MACKEREL_APIKEY is not necessary because mkr refers to /var/lib/mackerel-agent/id and /etc/mackerel-agent/mackerel-agent.conf instead of specifying manually.
```
mkr status
```
```
mkr update --status maintenance ...
```
```
mkr fetch --name loadavg5
```
```bash
cat <
```
mkr retire
```
## ADVANCED USAGE
```bash
$ mkr update --st working $(mkr hosts -s My-Service -r proxy | jq -r '.[].id')
```
## Using Docker Image
https://hub.docker.com/r/mackerel/mkr/
```bash
$ docker run --rm --env MACKEREL_APIKEY= mackerel/mkr help
```
# CONTRIBUTION
1. Fork ([https://github.com/mackerelio/mkr/fork](https://github.com/mackerelio/mkr/fork))
2. Create a feature branch
3. Commit your changes
4. Rebase your local changes against the master branch
5. Run test suite with the `go test ./...` command and confirm that it passes
6. Run `gofmt -s`
7. Create new Pull Request
License
----------
Copyright 2014 Hatena Co., Ltd.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.