Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/m3db/m3
M3 monorepo - Distributed TSDB, Aggregator and Query Engine, Prometheus Sidecar, Graphite Compatible, Metrics Platform
https://github.com/m3db/m3
aggregator graphite kubernetes m3 metrics prometheus query-engine tsdb
Last synced: 10 days ago
JSON representation
M3 monorepo - Distributed TSDB, Aggregator and Query Engine, Prometheus Sidecar, Graphite Compatible, Metrics Platform
- Host: GitHub
- URL: https://github.com/m3db/m3
- Owner: m3db
- License: apache-2.0
- Created: 2016-06-14T20:29:45.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-10-01T21:40:31.000Z (about 1 month ago)
- Last Synced: 2024-10-02T01:41:48.142Z (about 1 month ago)
- Topics: aggregator, graphite, kubernetes, m3, metrics, prometheus, query-engine, tsdb
- Language: Go
- Homepage: https://m3db.io/
- Size: 100 MB
- Stars: 4,742
- Watchers: 112
- Forks: 452
- Open Issues: 216
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Governance: GOVERNANCE.md
Awesome Lists containing this project
- awesome - m3 - M3 monorepo - Distributed TSDB, Aggregator and Query Engine, Prometheus Sidecar, Graphite Compatible, Metrics Platform (Go)
- my-awesome - m3db/m3 - engine,tsdb pushed_at:2024-11 star:4.8k fork:0.5k M3 monorepo - Distributed TSDB, Aggregator and Query Engine, Prometheus Sidecar, Graphite Compatible, Metrics Platform (Go)
- awesome-monorepo - M3 monorepo - 分布式TSDB，聚合器和查询引擎，Prometheus Sidecar，度量衡平台
- awesome-repositories - m3db/m3 - M3 monorepo - Distributed TSDB, Aggregator and Query Engine, Prometheus Sidecar, Graphite Compatible, Metrics Platform (Go)
- awesome-starts - m3db/m3 - M3 monorepo - Distributed TSDB, Aggregator and Query Engine, Prometheus Sidecar, Graphite Compatible, Metrics Platform (Go)
- awesome-list - m3 - Distributed TSDB, Aggregator and Query Engine, Prometheus Sidecar, Graphite Compatible, Metrics Platform | m3db | 3710 | (Go)
- awesome-cloud-native - m3 - M3 monorepo - Distributed TSDB, Aggregator and Query Engine, Prometheus Sidecar, Graphite Compatible, Metrics Platform. (Database)
README
# M3
[![GoDoc][doc-img]][doc] [![Build Status][ci-img]][ci] [![FOSSA Status][fossa-img]][fossa]
[Distributed TSDB](https://m3db.io/docs/reference/m3db/) and [Query Engine](https://m3db.io/docs/how_to/query/), [Prometheus Sidecar](https://m3db.io/docs/integrations/prometheus/), [Metrics Aggregator](https://m3db.io/docs/overview/reference/#m3-aggregator), and more such as [Graphite storage and query engine](https://m3db.io/docs/integrations/graphite/).
## Table of Contents
- [More Information](#more-information)
- [Install](#install)
- [Dependencies](#dependencies)
- [Usage](#usage)
- [Contributing](#contributing)
## More Information
- [Documentation](https://m3db.io/docs)
- [Contributing](CONTRIBUTING.md)
- [Slack](http://bit.ly/m3slack)
- [Forum (Google Group)](https://groups.google.com/forum/#!forum/m3db)
### Community Meetings
You can find recordings of past meetups here: .
## Install
### Dependencies
The simplest and quickest way to try M3 is to use Docker, read [the M3 quickstart section](https://m3db.io/docs/quickstart) for other options.
This example uses [jq](https://stedolan.github.io/jq/) to format the output of API calls. It is not essential for using M3DB.
## Usage
The below is a simplified version of the [M3 quickstart guide](https://m3db.io/docs/quickstart/docker/), and we suggest you read that for more details.
1. Start a Container
```shell
docker run -p 7201:7201 -p 7203:7203 --name m3db -v $(pwd)/m3db_data:/var/lib/m3db quay.io/m3db/m3dbnode:v1.0.0
```
2. Create a Placement and Namespace
```shell
#!/bin/bash
curl -X POST http://localhost:7201/api/v1/database/create -d '{
"type": "local",
"namespaceName": "default",
"retentionTime": "12h"
}' | jq .
```
3. Ready a Namespace
```shell
curl -X POST http://localhost:7201/api/v1/services/m3db/namespace/ready -d '{
"name": "default"
}' | jq .
```
4. Write Metrics
```shell
#!/bin/bash
curl -X POST http://localhost:7201/api/v1/json/write -d '{
"tags":
{
"__name__": "third_avenue",
"city": "new_york",
"checkout": "1"
},
"timestamp": '\"$(date "+%s")\"',
"value": 3347.26
}'
```
5. Query Results
**Linux**
```shell
curl -X "POST" -G "http://localhost:7201/api/v1/query_range" \
-d "query=third_avenue" \
-d "start=$(date "+%s" -d "45 seconds ago")" \
-d "end=$( date +%s )" \
-d "step=5s" | jq .
```
**macOS/BSD**
```shell
curl -X "POST" -G "http://localhost:7201/api/v1/query_range" \
-d "query=third_avenue > 6000" \
-d "start=$(date -v -45S "+%s")" \
-d "end=$( date +%s )" \
-d "step=5s" | jq .
```
## Contributing
You can ask questions and give feedback in the following ways:
- [Create a GitHub issue](https://github.com/m3db/m3/issues)
- [In the public M3 Slack](http://bit.ly/m3slack)
- [In the M3 forum (Google Group)](https://groups.google.com/forum/#!forum/m3db)
M3 welcomes pull requests, read [contributing guide](CONTRIBUTING.md) to help you get setup for building and contributing to M3.
This project is released under the [Apache License, Version 2.0](LICENSE).
[doc-img]: https://godoc.org/github.com/m3db/m3?status.svg
[doc]: https://godoc.org/github.com/m3db/m3
[ci-img]: https://badge.buildkite.com/5509d9360bfea7f99ac3a07fd029feb1aafa5cff9ed5ab667b.svg?branch=master
[ci]: https://buildkite.com/uberopensource/m3-monorepo-ci
[cov-img]: https://codecov.io/gh/m3db/m3/branch/master/graph/badge.svg
[cov]: https://codecov.io/gh/m3db/m3
[fossa-img]: https://app.fossa.io/api/projects/custom%2B4529%2Fgithub.com%2Fm3db%2Fm3.svg?type=shield
[fossa]: https://app.fossa.io/projects/custom%2B4529%2Fgithub.com%2Fm3db%2Fm3?ref=badge_shield