-
Notifications
You must be signed in to change notification settings - Fork 185
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 CONTRIBUTING.md document #146
Open
dswarbrick
wants to merge
1
commit into
master
Choose a base branch
from
contributing
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Contributing | ||
|
||
The Prometheus Community welcomes contributions to the node_exporter textfile | ||
collector script repository adhering to the following criteria: | ||
|
||
Ideally, scripts should not duplicate functionality that is already available in | ||
dedicated exporters. The textfile collector script collection is largely | ||
intended to provide stop-gap measures, parsing output from third-party tools | ||
(e.g. RAID controller utilities), or in situations where elevated privileges | ||
(e.g. root access) are required. | ||
|
||
Textfile collector scripts should be written in either Python or shell script. | ||
Scripts are expected to output metrics to `stdout` in the [Prometheus text-based | ||
format][1], and should not directly write to an output file. | ||
|
||
Metric and label names should follow the Prometheus [naming guidelines][2]. | ||
|
||
## Python Scripts | ||
|
||
- Must use Python 3.x. | ||
- Must use the official Prometheus Python [client library][3], which greatly | ||
simplifies ensuring valid metric output format. | ||
- Must pass a [flake8][4] lint check (enforced by CI pipeline). | ||
|
||
## Shell Scripts | ||
|
||
- Must use either Bash or generic POSIX-compatible shell (e.g. `/bin/sh`). | ||
- Must pass a [shellcheck][5] lint check (enforced by CI pipeline). | ||
- With the exception of specific third-party / closed-source tools, should avoid | ||
using "exotic" commands that are unlikely to be present on typical systems. | ||
|
||
[1]: https://prometheus.io/docs/instrumenting/exposition_formats/#text-based-format | ||
[2]: https://prometheus.io/docs/practices/naming/ | ||
[3]: https://github.com/prometheus/client_python | ||
[4]: https://flake8.pycqa.org/ | ||
[5]: https://www.shellcheck.net/ |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How should Python scripts state requirements beyond prometheus-client?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One idea, we could move to having directory-per-script and
requirements.txt
files for python scripts.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yup, that's certainly possible. I am a Python noob, especially on tooling, so is there a way to do
pip install github.com:org/repo/subfolder#revision
or something similar?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not really. you can
pip install .
from within a directory, but typically you'd ship this whole project as one big project on pypi and install it as one chunk.that said, i am not sure you'd want to set that as policy right now. i would suggest you start with the drafted policy as is, and then maybe iterate once this PR is merged, as python packaging is rather more complicated than, say, shell scripts.
personnally, i wouldn't do the requirements.txt dance at all and keep things at a simple one-file-per-script approach. more complicated exporters should just have their own git projects IMHO.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Like @anarcat, I think that once something crosses the threshold of being pip-installable, it really ought to move to its own repo which can better cater to its needs such as having a
requirements.txt
, and the main focus of that repo being $foo.If we were going to make this repo pip-installable, I think we would need to more accurately define what the mission of this repo is. At present, it's just a jumble of unrelated textfile collector scripts, which is fine - so long as it doesn't promise to be anything more.