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

Add analyzer to detect standalone backend debug files #89

Merged
merged 4 commits into from
Mar 7, 2023

Conversation

xnyo
Copy link
Member

@xnyo xnyo commented Mar 3, 2023

Backend plugins support debug mode, which is implemented by placing a standalone.txt file in the dist folder, which will tell Grafana to connect to a GRPC server running on the address specified in that file.

Having this file in a production plugin makes it effectively unusable.

This analyzer also checks for pid.txt, which will be added by grafana/grafana-plugin-sdk-go#621 and will be used for backend debug mode (for plugins that use a new version of the SDK).

@xnyo xnyo added the enhancement New feature or request label Mar 3, 2023
@xnyo xnyo requested review from academo and briangann March 3, 2023 10:50
@sympatheticmoose
Copy link
Contributor

Could you add a row in https://github.com/grafana/plugin-validator#analyzers to document the analyzer? Apologies for adding new requirements mid PR!

@xnyo
Copy link
Member Author

xnyo commented Mar 6, 2023

No worries @sympatheticmoose ! I have changed the README, let me know what you think :)

Copy link
Contributor

@sympatheticmoose sympatheticmoose left a comment

Choose a reason for hiding this comment

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

Thanks for adding the readme update 🥇

@xnyo xnyo self-assigned this Mar 6, 2023
@xnyo xnyo merged commit 88cc2f3 into main Mar 7, 2023
@xnyo xnyo deleted the giuseppe/backend-debug branch March 7, 2023 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

3 participants