Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[documentation] Document prom-remote backend type #3777

Merged
merged 45 commits into from
Oct 7, 2021

Conversation

Antanukas
Copy link
Collaborator

@Antanukas Antanukas commented Sep 24, 2021

What this PR does / why we need it:
Documentation of a new backend type prom-remote

Special notes for your reviewer:

The idea was to give a very concrete examples on how to run M3 Coordinator with prom-remote storage localy.
I also describe 2 production deployment scenarios:

  • M3Coordinator with in process M3 Aggregator as a side car
  • Separate independently scalable M3 Coordinator and M3 Aggregator setup

Does this PR introduce a user-facing and/or backwards incompatible change?:

action required

Does this PR require updating code package or user-facing documentation?:

Prometheus integration documentation and 'how to' sections were updated.

@ChrisChinchilla
Copy link
Collaborator

@Antanukas Pretty good so far, just small grammar nits and tweaks.

Antanukas and others added 15 commits October 4, 2021 11:52
Co-authored-by: Chris Chinchilla <[email protected]>
Signed-off-by: ChrisChinchilla <[email protected]>
Passing the interrupt channel to multiple goroutines could
cause a race where the main thread ends up missing the interrupt
that triggers a server shutdown. This commit ensures that only
a single goroutine is listening for the interrupt at a given
time and all other interested parties can check the interrupted
channel. The interrupted channel will be closed as soon as
an interrupt is received. Since closed channels return immediately,
this allows any interested goroutine to know if it should terminate
by simply checking the interrupted channel.
This commit fixes a couple small things re: embedded coordinators:

1) Fails fast if dbnode is not started when creating an embedded
coordinator.

2) Adds support for port and filepath replacement in embedded
config.
…ss Coordinator (#3786)

This PR adds some admin functions to the in-process coordinators, so they can manage m3msg topics and aggregator placements.
In-process aggregators will be implemented based on this change.

Co-authored-by: Wesley Kim <[email protected]>
@Antanukas Antanukas marked this pull request as ready for review October 6, 2021 12:05
Copy link
Collaborator

@robskillington robskillington left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM after making some minor changes

@codecov
Copy link

codecov bot commented Oct 6, 2021

Codecov Report

Merging #3777 (b11cf74) into master (b11cf74) will not change coverage.
The diff coverage is n/a.

❗ Current head b11cf74 differs from pull request most recent head 2106ac5. Consider uploading reports for the commit 2106ac5 to get more accurate results

Impacted file tree graph

@@          Coverage Diff           @@
##           master   #3777   +/-   ##
======================================
  Coverage    57.0%   57.0%           
======================================
  Files         552     552           
  Lines       63120   63120           
======================================
  Hits        36023   36023           
  Misses      23902   23902           
  Partials     3195    3195           
Flag Coverage Δ
aggregator 63.3% <0.0%> (ø)
cluster ∅ <0.0%> (∅)
collector 58.4% <0.0%> (ø)
dbnode 60.7% <0.0%> (ø)
m3em 46.4% <0.0%> (ø)
metrics 19.7% <0.0%> (ø)
msg 74.5% <0.0%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b11cf74...2106ac5. Read the comment docs.

Copy link
Collaborator

@vpranckaitis vpranckaitis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tried the steps locally, works fine

site/content/integrations/prometheus.md Outdated Show resolved Hide resolved
@Antanukas Antanukas enabled auto-merge (squash) October 7, 2021 09:56
@Antanukas Antanukas merged commit 4cd1b14 into master Oct 7, 2021
@Antanukas Antanukas deleted the antanas/prom-remote-write-backend-docs branch October 7, 2021 10:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.