ReadTheDocs documentation for Table Configs, Monitoring, and Deployment #3975
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
First pass of 'Running Pinot in Production' docs, which includes sections on * Deploying Pinot and the ordering * Table configs and what each setting does * Monitoring (still needs proper metric names added)
Codecov Report
@@ Coverage Diff @@
## master #3975 +/- ##
============================================
+ Coverage 66.99% 67.05% +0.05%
- Complexity 4 20 +16
============================================
Files 1032 1033 +1
Lines 51047 51338 +291
Branches 7126 7181 +55
============================================
+ Hits 34200 34424 +224
- Misses 14502 14537 +35
- Partials 2345 2377 +32
Continue to review full report at Codecov.
|
Changes include: 1. Breaking out the table config section from the "Running Pinot in Production" section. I think this makes the doc easier to follow for table configs. I have a section here which includes a sample offline and realtime table config. I am not sure if there are some configs included as a way for users to run a local quick start. If there is I can link to those files in the repo, otherwise I can include the full configs on this page for users. 2. Adding links to metrics which I am able to find in the code. I need to collect feedback on what to do with the others - Remove or I need pointers to where I can find them in the code.
jgutmann
changed the title
The is two items I need before this is completed 1. I notice that the controller metrics appear to be generated dynamically due to table names being present in most of the metrics. I need some advice from the devs on how I should note these metric names so I can link to them in the code. I want to make sure it is clear to the users. 2. I want to add sample table configs in the "in_production.rst" section. I feel this would be best to be added in the git repo since they will be useful for the users in the quick start guides. I need Jack to tell me where in the repo I should put these files. Once they are in the repo I will link to them from that section.
dinoocch
suggested changes
Mar 19, 2019
added 3 commits
March 19, 2019 13:19
General cleanup and re-formatting based on feedback for my PR.
mcvsubbu
reviewed
Mar 21, 2019
jgutmann
commented
Mar 22, 2019
mcvsubbu
approved these changes
Mar 27, 2019
|
|
||
| Monitoring Pinot | ||
| ~~~~~~~~~~~~~~~~ | ||
|
|
||
| Pinot exposes several metrics to monitor the service and ensure that pinot users are not experiencing issues. In this section we discuss some of the key metrics that are useful to monitor. A full list of metrics is available in the `Metrics <customizations.html#metrics>`_ section. |
There was a problem hiding this comment.
we dont have a 'full list' so to speak.
so maybe we should remove this?
There was a problem hiding this comment.
ah i see you have a todo. no problem. your call.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
First pass of 'Running Pinot in Production' docs, which includes
sections on