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

Added documentation for the replication-lag-based-throttler #2581

Merged

Conversation

erzel
Copy link
Contributor

@erzel erzel commented Feb 23, 2017

Copy link
Contributor

@alainjobart alainjobart left a comment

Choose a reason for hiding this comment

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

Please also add what error code is triggered and returned to the client when their statement is throttled. Thanks!

# Caveats and Known Issues
* The throttler keeps trying to explore the maximum rate possible while keeping
the replication lag under the desired limit; as such the desired replication
lag limit may occaisionally be slightly violated.
Copy link
Contributor

Choose a reason for hiding this comment

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

typo: occaisionally

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks. Fixed.

A comma separated list of datacenter cells. The throttler will only monitor
the non-RDONLY replicas found in these cells for replication lag.

# Caveats and Known Issues
Copy link
Contributor

Choose a reason for hiding this comment

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

you need a new line after the title?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not really. Removed.

protocol buffer that contains configuration options for the throttler.
The most important fields in that message are *target_replication_lag_sec* and
*max_replication_lag_sec* that specify the desired limits on the replication lag. See the comments in the protocol definition file for more details.
If this is not specified a default configuration will be used.
Copy link
Contributor

Choose a reason for hiding this comment

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

is there a sample config in the tests? if so, link to it would be good.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

@erzel erzel force-pushed the adding_replication_lag_based_throttler_doc branch from 52c5cef to 2dfccb4 Compare February 23, 2017 23:26
@erzel
Copy link
Contributor Author

erzel commented Feb 23, 2017

Thanks for reviewing. PTAL.

@alainjobart
Copy link
Contributor

alainjobart commented Feb 24, 2017

LGTM

Approved with PullApprove

@erzel erzel merged commit b7597a9 into vitessio:master Feb 27, 2017
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.

3 participants