Skip to content

Improve Ruby SDK setup and update docs #9197

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
Merged
ccschmitz merged 7 commits into from
Aug 22, 2024
Merged

Improve Ruby SDK setup and update docs #9197

ccschmitz merged 7 commits into from
Aug 22, 2024

Conversation

@ccschmitz
Copy link
Contributor

@ccschmitz ccschmitz commented Aug 22, 2024 •
edited by Vadman97
Loading

Summary

Updates the Ruby SDK and docs.

  • Eliminates the need to set up the around_action to instrument requests by adding a Railtie and setting up the around_action as part of the initialization logic.
  • Adds an init alias so you can call Highlight.init rather than Highlight::H.new.
  • Fixes an issue where we were seeing warnings about incompatibility with ActiveSupport::LoggerSilence.
  • Updates the Ruby/Rails documentation.
  • Adds a /for page for Rails.
  • Fixes some broken links on existing /for pages.

Closes HIG-4900

How did you test this change?

Click tested locally in the E2E app + a local instance of the docs site.

Are there any deployment considerations?

New SDK version going out. Will see if I can get recent articles published about the Ruby SDK updated.

Does this work require review from our design team?

N/A

@linear
Copy link

linear bot commented Aug 22, 2024

GRO-109 Update Ruby docs

@changeset-bot
Copy link

changeset-bot bot commented Aug 22, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: 602a5a1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

💥 An error occurred when fetching the changed packages and changesets in this PR 
Some errors occurred when validating the changesets config:
The package or glob expression "rrdom" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.
The package or glob expression "rrdom-nodejs" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.
The package or glob expression "rrweb" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.
The package or glob expression "rrweb-player" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.
The package or glob expression "rrweb-snapshot" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.
The package or glob expression "@rrweb/all" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.
The package or glob expression "@rrweb/types" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.
The package or glob expression "@rrweb/record" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.
The package or glob expression "@rrweb/replay" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.
The package or glob expression "@rrweb/packer" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.
The package or glob expression "@rrweb/rrweb-plugin-canvas-webrtc-record" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.
The package or glob expression "@rrweb/rrweb-plugin-canvas-webrtc-replay" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.
The package or glob expression "@rrweb/rrweb-plugin-console-record" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.
The package or glob expression "@rrweb/rrweb-plugin-console-replay" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.
The package or glob expression "@rrweb/rrweb-plugin-sequential-id-record" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.
The package or glob expression "@rrweb/rrweb-plugin-sequential-id-replay" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.
The package or glob expression "@rrweb/utils" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.
The package or glob expression "@rrweb/web-extension" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.
The package or glob expression "rrvideo" is specified in the `ignore` option but it is not found in the project. You may have misspelled the package name or provided an invalid glob expression. Note that glob expressions must be defined according to https://www.npmjs.com/package/micromatch.

@ccschmitz ccschmitz requested review from a team and Vadman97 August 22, 2024 14:21
github-advanced-security[bot]
github-advanced-security bot found potential problems Aug 22, 2024
View reviewed changes
e2e/ruby/rails/demo/config/initializers/highlight.rb
require 'highlight'

Highlight::H.new('1jdkoe52', environment: 'dev', otlp_endpoint: 'http://localhost:4318') do |c|
Highlight.init('1jdkoe52', environment: 'dev', otlp_endpoint: 'http://localhost:4318') do |c|

Check notice

Code scanning / devskim

Accessing localhost could indicate debug code, or could hinder scaling.

Do not leave debug code in production
@ccschmitz ccschmitz marked this pull request as ready for review August 22, 2024 14:29
@linear
Copy link

linear bot commented Aug 22, 2024

HIG-4900 ruby sdk emitting noisy logs related to silent logger

Vadman97
Vadman97 approved these changes Aug 22, 2024
View reviewed changes
@ccschmitz ccschmitz merged commit b6a605f into main Aug 22, 2024
@ccschmitz ccschmitz deleted the gro-109-update-ruby-docs branch August 22, 2024 17:06
giraffekey pushed a commit to giraffekey/highlight that referenced this pull request Nov 21, 2024
@ccschmitz @giraffekey
Improve Ruby SDK setup and update docs (highlight#9197)
e0263cc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Vadman97 Vadman97 Vadman97 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ccschmitz @Vadman97