Skip to content

Commit

Permalink
Squashed commit of the following:
Browse files Browse the repository at this point in the history
commit 0ee043f
Author: ChrisChinchilla <[email protected]>
Date:   Wed Sep 16 18:11:50 2020 +0200

    Add Netlify TOML file

    Signed-off-by: ChrisChinchilla <[email protected]>

commit a91c5ec
Author: ChrisChinchilla <[email protected]>
Date:   Wed Sep 16 18:00:16 2020 +0200

    Final

    Signed-off-by: ChrisChinchilla <[email protected]>

commit 356abb8
Merge: febe502 47bd03b
Author: ChrisChinchilla <[email protected]>
Date:   Wed Sep 16 17:55:50 2020 +0200

    Merge branch 'master' into braskin/hugo_site

    Signed-off-by: ChrisChinchilla <[email protected]>

    # Conflicts:
    #	docs/content/coordinator/_index.md
    #	docs/content/coordinator/api/remote.md
    #	docs/content/how_to/query.md
    #	docs/content/m3query/api/query.md
    #	docs/content/m3query/architecture/_index.md
    #	docs/content/m3query/architecture/blocks.md
    #	docs/content/m3query/architecture/fanout.md
    #	docs/content/m3query/config/annotated_config.md
    #	docs/content/m3query/config/annotated_config.yaml
    #	docs/content/m3query/roadmap.md
    #	docs/content/operational_guide/bootstrapping_crash_recovery.md
    #	docs/content/operational_guide/monitoring.md
    #	docs/content/operational_guide/repairs.md
    #	docs/content/operational_guide/upgrading_m3.md
    #	docs/content/overview/components.md
    #	docs/coordinator/api/remote.md
    #	docs/includes/headers_optional_read_all.md
    #	docs/includes/headers_optional_read_limits.md
    #	docs/includes/headers_optional_write_all.md
    #	docs/index.md
    #	docs/m3coordinator/api/remote.md
    #	docs/m3db/architecture/storage.md
    #	docs/m3query/api/index.md
    #	docs/m3query/architecture/blocks.md
    #	docs/m3query/architecture/fanout.md
    #	docs/m3query/architecture/functions.md
    #	docs/m3query/config/annotated_config.md
    #	docs/m3query/config/annotated_config.yaml
    #	docs/m3query/roadmap.md
    #	docs/operational_guide/index.md
    #	docs/operational_guide/mapping_rollup.md
    #	docs/overview/media.md
    #	docs/query_engine/api/index.md
    #	docs/query_engine/architecture/blocks.md
    #	docs/query_engine/architecture/fanout.md
    #	docs/query_engine/config/annotated_config.md
    #	docs/query_engine/config/annotated_config.yaml
    #	docs/query_engine/roadmap.md
    #	docs/static/aggregator.md

commit febe502
Author: ChrisChinchilla <[email protected]>
Date:   Wed Sep 16 15:34:17 2020 +0200

    Fix paths

    Signed-off-by: ChrisChinchilla <[email protected]>

commit 8c300d5
Author: ChrisChinchilla <[email protected]>
Date:   Wed Sep 16 14:55:57 2020 +0200

    Link fixes

    Signed-off-by: ChrisChinchilla <[email protected]>

commit a4ca3db
Merge: 3325ed8 45ad2f6
Author: ChrisChinchilla <[email protected]>
Date:   Wed Sep 16 14:17:18 2020 +0200

    Merge commit '45ad2f6d6f1c23e387b8232b678e8c0d1093a5ca' into braskin/hugo_site

commit 45ad2f6
Author: ChrisChinchilla <[email protected]>
Date:   Wed Sep 16 14:17:18 2020 +0200

    Squashed 'docs/themes/docs-theme/' changes from cc1e7c4b7..5103e6cc3

    5103e6cc3 Remove centering

    git-subtree-dir: docs/themes/docs-theme
    git-subtree-split: 5103e6cc3427e97c469c2914246d4b46f7e27bd9

commit 3325ed8
Author: ChrisChinchilla <[email protected]>
Date:   Wed Sep 16 14:17:06 2020 +0200

    Fix links

    Signed-off-by: ChrisChinchilla <[email protected]>

commit 47bd03b
Author: Matt Schallert <[email protected]>
Date:   Tue Sep 15 18:47:31 2020 -0700

    [docs] Add recent talks (#2639)

commit 705f4f0
Author: Ryan Allen <[email protected]>
Date:   Tue Sep 15 20:54:45 2020 -0400

    [dbnode] query limits - missed commit with feedback (#2640)

commit b71785e
Author: Ryan Allen <[email protected]>
Date:   Tue Sep 15 15:19:25 2020 -0400

    [dbnode] additional query limit on bytes read (#2627)

commit 3aa2f51
Author: Linas Medžiūnas <[email protected]>
Date:   Tue Sep 15 21:13:41 2020 +0300

    [large-tiles] Cross block reader changes plus Cross block iterator (#2612)

    * [dbnode] Add OrderedByIndex option for DataFileSetReader.Open (#2465)

    * [dbnode] Cross-block series reader (#2481)

    * [dbnode] AggregateTiles RPC - minimal E2E flow (#2466)

    * [large-tiles] Cross block reader changes plus Cross block iterator

    * Fix TestReadAggregateWrite

    * Fix TestShardAggregateTiles

    * Dummy

    * Fix TestReadAggregateWrite

    * typo

    * Convert spaces to tabs in rpc.thrift

    * Change capitalization of source/target namespace

    * Fix copyright year in large_tiles_test.go

    * Remove a noop

    * PR feedback

    * PR 2617 feedback

    * PR feedback

    * More PR feedback

    * Fix unit test

    * Reuse read objects during aggregation

    * Renamed StreamingMode to StreamingEnabled

    * PR feedback

    * Indentation

    * Address PR feedback

    * Skip flaky TestReadAggregateWrite

    Co-authored-by: arnikola <[email protected]>

commit 8bcf5ac
Author: Rob Skillington <[email protected]>
Date:   Tue Sep 15 12:35:09 2020 -0400

    [changelog] Update changelog for 0.15.14 release (#2638)

commit 4b0fcb3
Author: ChrisChinchilla <[email protected]>
Date:   Tue Sep 15 16:40:53 2020 +0200

    Squashed 'docs/themes/docs-theme/' content from commit cc1e7c4b7

    git-subtree-dir: docs/themes/docs-theme
    git-subtree-split: cc1e7c4b7be99f7dd8ceaacf11e6094f297c5989

commit 0d8b1fa
Merge: 99b541e 4b0fcb3
Author: ChrisChinchilla <[email protected]>
Date:   Tue Sep 15 16:40:53 2020 +0200

    Merge commit '4b0fcb301a028aa8cecd46c100d8cde119737ccc' as 'docs/themes/docs-theme'

commit 99b541e
Author: ChrisChinchilla <[email protected]>
Date:   Tue Sep 15 16:40:42 2020 +0200

    Finalise glossary section

    Signed-off-by: ChrisChinchilla <[email protected]>

commit 90e38bc
Merge: 6d88723 2b5490b
Author: ChrisChinchilla <[email protected]>
Date:   Tue Sep 15 13:44:15 2020 +0200

    Merge commit '2b5490b211202f7959328b4f7e9b387ef5e4b6ab' into braskin/hugo_site

commit 2b5490b
Author: ChrisChinchilla <[email protected]>
Date:   Tue Sep 15 13:44:15 2020 +0200

    Squashed 'docs/themes/docs-theme/' changes from 06ca4188b..dcbf4649b

    dcbf4649b Change glossary path
    REVERT: 06ca4188b Change glossary path

    git-subtree-dir: docs/themes/docs-theme
    git-subtree-split: dcbf4649bbaa43fc21c12cbdb936999d4b6719d8

commit 6d88723
Merge: 957fb39 ce857e0
Author: ChrisChinchilla <[email protected]>
Date:   Tue Sep 15 12:28:23 2020 +0200

    Merge commit 'ce857e005246025a90ec4ddd933cee7cfab4488a' into braskin/hugo_site

commit ce857e0
Author: ChrisChinchilla <[email protected]>
Date:   Tue Sep 15 12:28:23 2020 +0200

    Squashed 'docs/themes/docs-theme/' changes from 7ac79e398..06ca4188b

    06ca4188b Change glossary path
    REVERT: 7ac79e398 Change glossary path

    git-subtree-dir: docs/themes/docs-theme
    git-subtree-split: 06ca4188b1b040ce0f6334c50aeaecf8352c789f

commit 957fb39
Merge: 571aed1 0ee3f03
Author: ChrisChinchilla <[email protected]>
Date:   Tue Sep 15 12:23:18 2020 +0200

    Merge commit '0ee3f033d96a0af227c42edb71274a5e081a6e04' into braskin/hugo_site

commit 0ee3f03
Author: ChrisChinchilla <[email protected]>
Date:   Tue Sep 15 12:23:18 2020 +0200

    Squashed 'docs/themes/docs-theme/' changes from d84a9b2e3..7ac79e398

    7ac79e398 Change glossary path
    REVERT: d84a9b2e3 Change glossary path

    git-subtree-dir: docs/themes/docs-theme
    git-subtree-split: 7ac79e398305a2dbdbd88b3cd36e3b4c31e7483a

commit 571aed1
Merge: 8ed0032 fa9fe8b
Author: ChrisChinchilla <[email protected]>
Date:   Tue Sep 15 12:13:12 2020 +0200

    Merge commit 'fa9fe8b2f4055b89cd23bd9f0a8b50fb70918fe3' into braskin/hugo_site

commit fa9fe8b
Author: ChrisChinchilla <[email protected]>
Date:   Tue Sep 15 12:13:12 2020 +0200

    Squashed 'docs/themes/docs-theme/' changes from 4dba9dd2e..d84a9b2e3

    d84a9b2e3 Change glossary path

    git-subtree-dir: docs/themes/docs-theme
    git-subtree-split: d84a9b2e3d94bc46382e79bb7b14775f5f9d29ff

commit 8ed0032
Author: ChrisChinchilla <[email protected]>
Date:   Tue Sep 15 12:13:03 2020 +0200

    Remove defunct files

    Signed-off-by: ChrisChinchilla <[email protected]>

commit 2ae9792
Author: Rob Skillington <[email protected]>
Date:   Tue Sep 15 00:39:21 2020 -0400

    [dbnode] Add ability to configure writes to initializing shards (#2615)

commit f83f576
Author: Rob Skillington <[email protected]>
Date:   Mon Sep 14 22:19:15 2020 -0400

    [changelog] Update out of date changelog for 0.15.13 (#2636)

commit 876cee8
Author: Linas Medžiūnas <[email protected]>
Date:   Mon Sep 14 22:11:29 2020 +0300

    [large-tiles] Large tiles aggregation flow (#2617)

commit d38ff54
Author: Matt Schallert <[email protected]>
Date:   Mon Sep 14 07:22:09 2020 -0700

    [m3admin] Allow /set for new placements (#2625)

    Previously `/set` required that a placement already exists in order to
    set it. This hinders operations such as preemptively creating a
    placement or replacing one that had been deleted via safe APIs.

    This PR allows using `/set` even if a placement didn't previously exist
    at that key.

commit d5fff76
Author: ChrisChinchilla <[email protected]>
Date:   Mon Sep 14 15:33:05 2020 +0200

    Squashed 'docs/themes/docs-theme/' content from commit 4dba9dd2e

    git-subtree-dir: docs/themes/docs-theme
    git-subtree-split: 4dba9dd2e0320cf0b9df05be01808a567781d5e3

commit 74ae18a
Merge: d707793 d5fff76
Author: ChrisChinchilla <[email protected]>
Date:   Mon Sep 14 15:33:05 2020 +0200

    Merge commit 'd5fff76fac215da9f96e751e916bb82cca6dc785' as 'docs/themes/docs-theme'

commit d707793
Author: ChrisChinchilla <[email protected]>
Date:   Mon Sep 14 15:32:55 2020 +0200

    Move

    Signed-off-by: ChrisChinchilla <[email protected]>

commit 93f3cd1
Merge: 42dbf19 8b276ed
Author: ChrisChinchilla <[email protected]>
Date:   Mon Sep 14 12:57:19 2020 +0200

    Merge commit '8b276ed170a886058c276535a127567a38210426' as 'docs/themes/docs-theme'

commit 8b276ed
Author: ChrisChinchilla <[email protected]>
Date:   Mon Sep 14 12:57:19 2020 +0200

    Squashed 'docs/themes/docs-theme/' content from commit 4bb3340df

    git-subtree-dir: docs/themes/docs-theme
    git-subtree-split: 4bb3340df8857eb8cd07b70515b546287617ca60

commit 42dbf19
Author: ChrisChinchilla <[email protected]>
Date:   Mon Sep 14 12:57:15 2020 +0200

    Continue

commit 07c034d
Author: teddywahle <[email protected]>
Date:   Mon Sep 14 01:03:57 2020 -0700

    [query] Implemented movingSum, movingMax, movingMin (graphite functions) (#2570)

commit e66e016
Author: teddywahle <[email protected]>
Date:   Mon Sep 14 00:48:27 2020 -0700

    [query] Add Graphite aliasByTags function (#2626)

commit d3cd566
Author: teddywahle <[email protected]>
Date:   Mon Sep 14 00:46:44 2020 -0700

    [query] Implemented the Graphite `exponentialMovingAverage` function (#2622)

commit 47eaa98
Author: arnikola <[email protected]>
Date:   Thu Sep 10 18:18:01 2020 -0400

    [query] Expose Graphite Compile method. (#2624)

commit 8223666
Author: nate <[email protected]>
Date:   Thu Sep 10 11:00:49 2020 -0400

    [dbnode] Fail if FetchTagged partially retrieves results due to error (#2610)

commit d103bae
Author: ChrisChinchilla <[email protected]>
Date:   Wed Sep 9 12:36:58 2020 +0200

    Remove netlify build from branch

commit 7759733
Author: ChrisChinchilla <[email protected]>
Date:   Wed Sep 9 12:35:32 2020 +0200

    Attempt to fix Netlify build

commit 7440118
Author: ChrisChinchilla <[email protected]>
Date:   Tue Sep 8 17:05:41 2020 +0200

    More

commit 76372de
Author: ChrisChinchilla <[email protected]>
Date:   Fri Sep 4 16:43:26 2020 +0200

    Struct

commit e74c381
Author: ChrisChinchilla <[email protected]>
Date:   Fri Aug 28 12:42:48 2020 +0200

    Further fixing

commit 3e357ac
Author: ChrisChinchilla <[email protected]>
Date:   Fri Aug 28 12:10:14 2020 +0200

    Continue

commit 6b50f87
Author: ChrisChinchilla <[email protected]>
Date:   Fri Aug 28 11:44:52 2020 +0200

    Continue

commit efddf37
Author: ChrisChinchilla <[email protected]>
Date:   Fri Aug 28 11:37:08 2020 +0200

    Start migration to Hugo

commit 1bbca4b
Author: ChrisChinchilla <[email protected]>
Date:   Mon Aug 17 16:29:09 2020 +0200

    Start quickstart rewrite

commit 97279a4
Author: ChrisChinchilla <[email protected]>
Date:   Thu Aug 13 16:33:02 2020 +0200

    Add hugo publish dir to gitignore

commit fdd275d
Author: ChrisChinchilla <[email protected]>
Date:   Thu Aug 13 16:25:58 2020 +0200

    Update publish path

commit e942b4c
Author: ChrisChinchilla <[email protected]>
Date:   Thu Aug 13 16:22:20 2020 +0200

    Miss-formed YAML broke build

commit 62b2fac
Author: ChrisChinchilla <[email protected]>
Date:   Thu Aug 13 16:20:25 2020 +0200

    Add netlify config for this preview branch

commit 3232961
Author: ChrisChinchilla <[email protected]>
Date:   Thu Aug 13 16:06:43 2020 +0200

    Remove rogue submodule

commit d884269
Author: ChrisChinchilla <[email protected]>
Date:   Thu Aug 13 15:56:55 2020 +0200

    Change submodule path

commit 3e42ed8
Author: ChrisChinchilla <[email protected]>
Date:   Thu Aug 13 15:53:59 2020 +0200

    Add theme as submodule

commit ce92f32
Author: ChrisChinchilla <[email protected]>
Date:   Thu Aug 13 14:37:49 2020 +0200

    Testing content

commit 40d6f9f
Author: ChrisChinchilla <[email protected]>
Date:   Thu Aug 13 14:37:33 2020 +0200

    Update config

commit accedc1
Author: ChrisChinchilla <[email protected]>
Date:   Thu Aug 13 14:37:25 2020 +0200

    remove folder

commit 6ed118b
Author: Gibbs Cullen <[email protected]>
Date:   Fri May 8 12:56:50 2020 -0400

    edits to operator section

commit 0167857
Author: Gibbs Cullen <[email protected]>
Date:   Fri May 8 11:01:58 2020 -0400

    initial formatting done

commit 21dc3af
Author: Gibbs Cullen <[email protected]>
Date:   Mon Apr 27 12:55:20 2020 -0400

    content trasferred to hugo site

commit ff7d60c
Author: Gibbs Cullen <[email protected]>
Date:   Tue Apr 21 21:07:00 2020 -0400

    updated outline

commit 642464c
Author: Gibbs Cullen <[email protected]>
Date:   Thu Apr 2 12:50:30 2020 -0400

    updated docs format in hugo

commit c431580
Author: Gibbs Cullen <[email protected]>
Date:   Mon Mar 30 18:51:17 2020 -0400

    hugo updates

commit 0249640
Author: Gibbs Cullen <[email protected]>
Date:   Fri Mar 27 19:28:34 2020 -0400

    new format

commit bb39315
Author: Benjamin Raskin <[email protected]>
Date:   Mon Mar 2 15:22:36 2020 -0500

    [WIP][docs] Add hugo theme

Signed-off-by: ChrisChinchilla <[email protected]>
  • Loading branch information
ChrisChinchilla committed Sep 17, 2020
1 parent 5ebe79b commit bcca185
Show file tree
Hide file tree
Showing 481 changed files with 18,762 additions and 2,387 deletions.
25 changes: 25 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,30 @@
# Changelog

# 0.15.14

## Features

- **M3Query**: Add movingSum, movingMax, movingMin Graphite functions ([#2570](https://github.com/m3db/m3/pull/2570))
- **M3Query**: Add aliasByTags Graphite function ([#2626](https://github.com/m3db/m3/pull/2626))
- **M3Query**: Add exponentialMovingAverage Graphite function ([#2622](https://github.com/m3db/m3/pull/2622))
- **M3Query**: Add timeSlice Graphite function ([#2581](https://github.com/m3db/m3/pull/2581))
- **M3Query**: Add delay Graphite function ([#2567](https://github.com/m3db/m3/pull/2567))
- **M3Query**: Add aggregateWithWildcards Graphite function ([#2582](https://github.com/m3db/m3/pull/2582))
- **M3Query**: Add groupByNodes Graphite function ([#2579](https://github.com/m3db/m3/pull/2579))
- **M3Coordinator**: Allow using the placement set API for creating new placements as well as upserting existing placements ([#2625](https://github.com/m3db/m3/pull/2625))
- **M3DB**: Add bootstrap time migration config which supports seamless backwards and forwards compatible fileset upgrades ([#2521](https://github.com/m3db/m3/pull/2521))

# 0.15.13

## Bug Fixes

- **M3DB**: Fix case insensitive regexp modifiers (?i) implementation for metrics selector ([#2564](https://github.com/m3db/m3/pull/2564))

## Misc

- **M3DB**: Expose stream batch client options to config ([#2576](https://github.com/m3db/m3/pull/2576))
- **M3Query**: Metrics visibility and ability to limit number of encoders per block ([#2516](https://github.com/m3db/m3/pull/2516))

# 0.15.12

## Bug Fixes
Expand Down
118 changes: 118 additions & 0 deletions docs/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
# Change the default theme to be use when building the site with Hugo
theme = "docs-theme"

baseURL = "/"
languageCode = "en-US"
defaultContentLanguage = "en"
staticDir = ["static"]

title = "M3DB Documentation"
metaDataFormat = "yaml"
defaultContentLanguageInSubdir= true

# Highlighting config.
pygmentsCodeFences = true
pygmentsUseClasses = false
# Use the new Chroma Go highlighter in Hugo.
pygmentsUseClassic = false
#pygmentsOptions = "linenos=table"
# See https://help.farbox.com/pygments.html
# pygmentsStyle = "vs"

enableGitInfo = true

[frontmatter]
# date = ["date", ":filename", "publishDate", "lastmod"]

# Image processing configuration.
[imaging]
resampleFilter = "CatmullRom"
quality = 75
anchor = "smart"

[services]
[services.googleAnalytics]
# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
# id = "UA-00000000-0"

#fullversion = "v1.18.0"
#version = "v1.18"
githubbranch = "master"
docsbranch = "master"
deprecated = false
#currentUrl = "https://kubernetes.io/docs/home/"
#nextUrl = "https://kubernetes-io-vnext-staging.netlify.com/"
githubWebsiteRepo = "https://github.com/m3db/m3"
githubWebsiteRaw = "raw.githubusercontent.com/m3db/m3"

# Enable Algolia DocSearch
# algolia_docsearch = false

# Enable Lunr.js offline search
offlineSearch = false

[params]
# Prefix URL to edit current page. Will display an "Edit this page" button on top right hand corner of every page.
# Useful to give opportunity to people to create merge request for your doc.
# See the config.toml file from this documentation site to have an example.
editURL = "https://github.com/m3db/m3"
# Author of the site, will be used in meta information
author = "m3"
# Description of the site, will be used in meta information
description = "m3documentation"
# Shows a checkmark for visited pages on the menu
showVisitedLinks = false
# Disable search function. It will hide search bar
disableSearch = false
# Javascript and CSS cache are automatically busted when new version of site is generated.
# Set this to true to disable this behavior (some proxies don't handle well this optimization)
disableAssetsBusting = false
# Set this to true to disable copy-to-clipboard button for inline code.
disableInlineCopyToClipBoard = true
# A title for shortcuts in menu is set by default. Set this to true to disable it.
disableShortcutsTitle = false
# When using mulitlingual website, disable the switch language button.
disableLanguageSwitchingButton = false
# Hide breadcrumbs in the header and only show the current page title
disableBreadcrumb = true
# Hide Next and Previous page buttons normally displayed full height beside content
disableNextPrev = true
# Order sections in menu by "weight" or "title". Default to "weight"
ordersectionsby = "weight"
# Change default color scheme with a variant one. Can be "red", "blue", "green".
themeVariant = "blue"
twitter = "m3db_io"

# TODO: Do not like doing this really
[markup]
[markup.goldmark]
[markup.goldmark.renderer]
unsafe = true
[markup.goldmark.parser]
attribute = true
autoHeadingID = true
autoHeadingIDType = "github"
[markup.tableOfContents]
endLevel = 3
ordered = false
startLevel = 2
[markup.goldmark.extensions]
definitionList = true
footnote = true
linkify = true
strikethrough = true
table = true
taskList = true
typographer = true

[[Languages.en.menu.shortcuts]]
name = "<i class='fab fa-fw fa-github'></i> GitHub"
identifier = "ds"
url = "https://github.com/m3db/m3"
weight = 10

[outputs]
home = [ "HTML", "RSS", "JSON"]
page = [ "HTML"]
section = [ "HTML"]
chapter = [ "HTML"]
43 changes: 43 additions & 0 deletions docs/content/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: M3 Introduction
weight: 1
---


## About

After using open-source metrics solutions and finding issues with them at scale – such as reliability, cost, and
operational complexity – [M3](https://github.com/m3db/m3) was created from the ground up to provide Uber with a
native, distributed time series database, a highly-dynamic and performant aggregation service, a query engine, and
other supporting infrastructure.

## Key Features

M3 has several features, provided as discrete components, which make it an ideal platform for time series data at scale:

- A distributed time series database, [M3DB](m3db/), that provides scalable storage for time series data and a reverse index.
- A sidecar process, [M3Coordinator](integrations/prometheus), that allows M3DB to act as the long-term storage for Prometheus.
- A distributed query engine, [M3Query](query_engine), with native support for PromQL and Graphite (M3QL coming soon).
<!-- Add M3Aggregator link -->
- An aggregation tier, M3Aggregator, that runs as a dedicated metrics aggregator/downsampler allowing metrics to be stored at various retentions at different resolutions.

## Getting Started

**Note:** Make sure to read our [Operational Guides](operational_guide) before running in production!

Getting started with M3 is as easy as following one of the How-To guides.

- [Single M3DB node deployment](how_to/single_node)
- [Clustered M3DB deployment](how_to/cluster_hard_way)
- [M3DB on Kubernetes](how_to/kubernetes)
- [Isolated M3Query on deployment](how_to/query)

## Support

For support with any issues, questions about M3 or its operation, or to leave any comments, the team can be
reached in a variety of ways:

- [Slack (main chat channel)](http://bit.ly/m3slack)
- [Gitter (old chat channel)](https://gitter.im/m3db/Lobby)
- [Email](https://groups.google.com/forum/#!forum/m3db)
- [Github issues](https://github.com/m3db/m3/issues)
File renamed without changes.
File renamed without changes.
14 changes: 14 additions & 0 deletions docs/content/coordinator/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: "M3 Coordinator, API for reading/writing metrics and management"
menuTitle: "M3 Coordinator"
weight: 4
chapter: true
---

M3 Coordinator is a service that coordinates reads and writes between upstream systems, such as Prometheus, and downstream systems, such as M3DB.

It also provides management APIs to setup and configure different parts of M3.

The coordinator is generally a bridge for read and writing different types of metrics formats and a management layer for M3.

**Note**: M3DB by default includes the M3 Coordinator accessible on port 7201. For production deployments it is recommended to deploy it as a dedicated service to ensure you can scale the write coordination role separately and independently to database nodes as an isolated application separate from the M3DB database role.
File renamed without changes.
14 changes: 9 additions & 5 deletions docs/faqs/index.md → docs/content/faqs/_index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# FAQs
---
title: "FAQs"
weight: 9
chapter: true
---

- **Is there a way to disable M3DB embedded `etcd` and just use an external `etcd` cluster?**
Yes, you can definitely do that. It's all just about setting the etcd endpoints in config as etcd hosts instead of M3DB hosts. See [these docs](../operational_guide/etcd.md#external-etcd) for more information on configuring an external `etcd` cluster.
Expand All @@ -7,7 +11,7 @@ Yes, you can definitely do that. It's all just about setting the etcd endpoints
Yes, you can use the [Prometheus remote write client](https://github.com/m3db/prometheus_remote_client_golang/).

- **Why does my dbnode keep OOM’ing?**
Refer to the [troubleshooting guide](../troubleshooting/index.md).
Refer to the [troubleshooting guide](/troubleshooting).

- **Do you support PromQL?**
Yes, M3Query and M3Coordinator both support PromQL.
Expand All @@ -29,7 +33,7 @@ If you’re adding namespaces, the m3dbnode process will pickup the new namespac
If you’re removing or modifying an existing namespace, you’ll need to restart the m3dbnode process in order to complete the namespace deletion/modification process. It is recommended to restart one node at a time and wait for a node to be completely bootstrapped before restarting another node.

- **How do I set up aggregation in the coordinator?**
Refer to the [Aggregation section](../how_to/query.md) of the M3Query how-to guide.
Refer to the [Aggregation section](/how_to/query) of the M3Query how-to guide.

- **How do I set up aggregation using a separate aggregation tier?**
See this [WIP documentation](https://github.com/m3db/m3/pull/1741/files#diff-0a1009f86783ca8fd4499418e556c6f5).
Expand Down Expand Up @@ -61,7 +65,7 @@ etcdClusters:
```

- **How can I get a heap dump, cpu profile, etc.**
See our docs on the [/debug/dump api](../troubleshooting/index.md)
See our docs on the [/debug/dump api](/troubleshooting)

- **How much memory utilization should I run M3DB at?**
We recommend not going above 50%.
Expand All @@ -70,7 +74,7 @@ We recommend not going above 50%.
TBA

- **What is the recommended way to create a new namespace?**
Refer to the [Namespace configuration guide](../operational_guide/namespace_configuration.md).
Refer to the [Namespace configuration guide](/operational_guide/namespace_configuration).

- **How can I see the cardinality of my metrics?**
Currently, the best way is to go to the [M3DB Node Details Dashboard](https://grafana.com/grafana/dashboards/8126) and look at the `Ticking` panel. However, this is not entirely accurate because of the way data is stored in M3DB -- time series are stored inside time-based blocks that you configure. In actuality, the `Ticking` graph shows you how many unique series there are for the most recent block that has persisted. In the future, we plan to introduce easier ways to determine the number of unique time series.
15 changes: 15 additions & 0 deletions docs/content/glossary/bootstrapping.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Bootstrapping
id: bootstrapping
date: 2019-06-15
full_link:
short_description: >
I am a test term.
aka:
tags:
- example
- illustration
---

Process by which an M3DB node is brought up. Bootstrapping consists of determining the integrity of data that the node has, replay writes from the commit log, and/or stream missing data from its peers.
15 changes: 15 additions & 0 deletions docs/content/glossary/cardinality.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Cardinality
id: cardinality
date: 2019-06-15
full_link:
short_description: >
I am a test term.
aka:
tags:
- example
- illustration
---

The number of unique metrics within the M3DB index. Cardinality increases with the number of unique tag/value combinations that are being emitted.
15 changes: 15 additions & 0 deletions docs/content/glossary/datapoint.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Datapoint
id: datapoint
date: 2019-06-15
full_link:
short_description: >
I am a test term.
aka:
tags:
- example
- illustration
---

A single timestamp/value. Timeseries are composed of multiple datapoints and a series of tag/value pairs
12 changes: 12 additions & 0 deletions docs/content/glossary/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Standardized Glossary
layout: glossary
noedit: true
default_active_tag: test
weight: 5
card:
name: reference
weight: 10
title: Glossary
---

16 changes: 16 additions & 0 deletions docs/content/glossary/labels.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Labels
id: labels
date: 2019-06-15
full_link:
short_description: >
I am a test term.
aka:
tags:
- example
- illustration
---

Pairs of descriptive words that give meaning to a metric. Tags and Labels are interchangeable terms.

16 changes: 16 additions & 0 deletions docs/content/glossary/m3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: M3
id: m3
date: 2019-06-15
full_link:
short_description: >
I am a test term.
aka:
tags:
- example
- illustration
---

Highly scalable, distributed metrics platform that is comprised of a native, distributed time series database, a highly-dynamic and performant aggregation service, a query engine, and other supporting infrastructure.

15 changes: 15 additions & 0 deletions docs/content/glossary/m3coordinator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: M3Coordinator
id: m3coordinator
date: 2019-06-15
full_link:
short_description: >
I am a test term.
aka:
tags:
- example
- illustration
---

A service within M3 that coordinates reads and writes between upstream systems, such as Prometheus, and downstream systems, such as M3DB.
16 changes: 16 additions & 0 deletions docs/content/glossary/m3db.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: M3DB
id: m3db
date: 2019-06-15
full_link:
short_description: >
I am a test term.
aka:
tags:
- example
- illustration
---

Distributed time series database influenced by Gorilla and Cassandra released as open source by Uber Technologies.

Loading

0 comments on commit bcca185

Please sign in to comment.