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.

Sign up for GitHub

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

Jump to bottom

content/docs/en/18.0: document instrumented AWS:Request:Send operation #1414

Merged
merged 1 commit into from
Dec 21, 2023
Merged

content/docs/en/18.0: document instrumented AWS:Request:Send operation #1414

merged 1 commit into from
Dec 21, 2023

Conversation

maxenglander
Copy link
Collaborator

@maxenglander maxenglander commented Mar 17, 2023 •
edited
Loading

Add mysqlctl/backupstats instrumentation for S3. Adds the following new stats:

vtbackup_backup_count{component="BackupStorage",implementation="S3",operation="AWS:Request:Send"}
vtbackup_backup_duration_nanoseconds{component="BackupStorage",implementation="S3",operation="AWS:Reqest:Send"}
vtbackup_restore_count{component="BackupStorage",implementation="S3",operation="AWS:Request:Send"}
vtbackup_restore_duration_nanoseconds{component="BackupStorage",implementation="S3",operation="AWS:Reqest:Send"}

Accompanies vitessio/vitess#12500

@maxenglander maxenglander mentioned this pull request Mar 17, 2023
Merged
4 tasks
@netlify
Copy link

netlify bot commented Mar 17, 2023 •
edited
Loading

✅ Deploy Preview for vitess ready!

Name Link
🔨 Latest commit 5fd195f
🔍 Latest deploy log https://app.netlify.com/sites/vitess/deploys/6501808d34693b00080c2120
😎 Deploy Preview https://deploy-preview-1414--vitess.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@maxenglander maxenglander marked this pull request as ready for review March 17, 2023 20:52
@maxenglander maxenglander changed the base branch from prod to maxeng-details-backup-stats-metrics-new March 17, 2023 20:52
ajm188
ajm188 approved these changes Mar 18, 2023
View reviewed changes
content/en/docs/17.0/reference/backup-and-restore/metrics.md Outdated
@@ -46,6 +42,26 @@ These operations are counted and timed, and the number of bytes consumed or prod

_restore_duration_seconds_ times the duration of a restore. This metric is deprecated and will be removed in a future release. Use _RestoreDurationNanoseconds_ instead.

#### Instrumented components and operations
Copy link
Contributor

Choose a reason for hiding this comment

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

non-blocking, but something to think on: is there a way to programmatically generate this (not necessarily as the literal markdown table output, but at least the data backing it) from the source? that way we don't risk (as much) forgetting to keep this in sync with the code

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I like that idea. Do we have any existing examples of doing something like that?

@maxenglander
Copy link
Collaborator Author

Returning this to draft for now..think I need to make some code change (unrelated to ajm188's comments).

@maxenglander maxenglander marked this pull request as draft March 20, 2023 13:35
Base automatically changed from maxeng-details-backup-stats-metrics-new to prod March 29, 2023 13:53
@maxenglander maxenglander changed the title content/docs/en/17.0: document instrumented s3 upload time content/docs/en/17.0: document instrumented AWS:Request:Send operation Apr 20, 2023
@maxenglander maxenglander marked this pull request as ready for review April 21, 2023 01:23
@harshit-gangal
Copy link
Member

there are conflict with the changed, needs to be fixed before merging

@maxenglander
Copy link
Collaborator Author

there are conflict with the changed, needs to be fixed before merging

@harshit-gangal can you point me to the conflicts you are seeing? GitHub is not showing me conflicts on this docs PR or the code PR.

@harshit-gangal
Copy link
Member

I am not sure but I am seeing this

image

@deepthi
Copy link
Member

deepthi commented Jun 20, 2023

We can merge this only along with the linked code PR, which hasn't made it into v17. Can you change this PR to move the docs to v18?

@maxenglander maxenglander force-pushed the maxeng-vtb-s3-stats branch 2 times, most recently from d0d3b83 to cd256b2 Compare June 20, 2023 20:54
@maxenglander maxenglander changed the title content/docs/en/17.0: document instrumented AWS:Request:Send operation content/docs/en/18.0: document instrumented AWS:Request:Send operation Jun 20, 2023
@maxenglander
Copy link
Collaborator Author

@deepthi done and updated the changelog in vitessio/vitess#12500

@deepthi
Copy link
Member

deepthi commented Sep 12, 2023 •
edited
Loading

@maxenglander there are conflicts now. Can you resolve them when you get a chance? Then we can merge this.

@maxenglander
content/docs/en/18.0: document instrumented AWS:Request:Send operation
5fd195f 
Signed-off-by: Max Englander <max@planetscale.com>
@maxenglander
Copy link
Collaborator Author

@deepthi done, thanks

@rohit-nayak-ps rohit-nayak-ps merged commit a133bb8 into prod Dec 21, 2023
@rohit-nayak-ps rohit-nayak-ps deleted the maxeng-vtb-s3-stats branch December 21, 2023 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ajm188 ajm188 ajm188 approved these changes

@deepthi deepthi Awaiting requested review from deepthi

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@maxenglander @harshit-gangal @deepthi @ajm188 @rohit-nayak-ps