databricks/m3

databricks/m3

Description: M3 monorepo - Distributed TSDB, Aggregator and Query Engine, Prometheus Sidecar, Graphite Compatible, Metrics Platform

Language: Go

License: Apache-2.0

Stars: 4

Forks: 10

Open issues: 2

Created: 2022-07-08T16:46:57Z

Pushed: 2026-05-04T17:02:34Z

Default branch: db_main

Fork: yes

Parent repository: m3db/m3

Archived: no

README:

M3

[![GoDoc][doc-img]][doc] [![Build Status][ci-img]][ci] [![FOSSA Status][fossa-img]][fossa]

Distributed TSDB and Query Engine, Prometheus Sidecar, Metrics Aggregator, and more such as Graphite storage and query engine.

Table of Contents

• [More Information](#more-information)
• [Install](#install)
• [Dependencies](#dependencies)
• [Usage](#usage)
• [Contributing](#contributing)

More Information

• Documentation
• [Contributing](CONTRIBUTING.md)
• Slack
• Forum (Google Group)

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 for other options.

This example uses 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, and we suggest you read that for more details.

1. Start a Container

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

#!/bin/bash
curl -X POST http://localhost:7201/api/v1/database/create -d '{
"type": "local",
"namespaceName": "default",
"retentionTime": "12h"
}' | jq .

3. Ready a Namespace

curl -X POST http://localhost:7201/api/v1/services/m3db/namespace/ready -d '{
"name": "default"
}' | jq .

4. Write Metrics

#!/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

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

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
• In the public M3 Slack
• In the M3 forum (Google Group)

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