Add Snowflake exporter RSA key-pair authentication #890
Conversation
docs/sources/reference/components/prometheus.exporter.snowflake.md
Outdated
Show resolved
Hide resolved
Caleb-Hurshman
force-pushed
the
feat/snowflake-exporter-rsa
branch
from
e727a50
to
40367a0
Compare
| | Name | Type | Description | Default | Required | | ||
| | ---------------------- | -------- | -------------------------------------------------------------------------------------------- | ---------------- | -------- | | ||
| | `account_name` | `string` | The account to collect metrics for. | | yes | | ||
| | `username` | `string` | The username for the user used when querying metrics. | | yes | |
There was a problem hiding this comment.
username, password, private_key_path and private_key_password should all be optional from not on, no?
There was a problem hiding this comment.
Additionally, we should add some documentation explaining how to use these variables. Like, one or the other, precedence order, etc.
There was a problem hiding this comment.
Agreed on the first point, but there are scenarios where these are required, so some thought this qualified as 'required'. I had an earlier version with more details outside of the table, but opted to add to the field descriptions instead. I'll add these comments back in, let me know what you think.
| account_name = ACCOUNT_NAME | ||
| username = USERNAME | ||
| private_key_path = /PATH/TO/rsa_key.p8 | ||
| private_key_password = PASSWORD | ||
| warehouse = WAREHOUSE |
There was a problem hiding this comment.
| account_name = ACCOUNT_NAME | |
| username = USERNAME | |
| private_key_path = /PATH/TO/rsa_key.p8 | |
| private_key_password = PASSWORD | |
| warehouse = WAREHOUSE | |
| account_name = <ACCOUNT_NAME> | |
| username = <USERNAME> | |
| private_key_path = <PATH_TO_rsa_key.p8> | |
| private_key_password = <PASSWORD> | |
| warehouse = <WAREHOUSE> |
For consistency with the direction the docs are taking, we should use the placeholder variable notation defined here: https://grafana.com/docs/writers-toolkit/write/style-guide/write-for-developers/#placeholder-variables
Example with this style implemented: https://grafana.com/docs/alloy/latest/reference/components/discovery.azure/#example
This is still a work in progress... and many topics still need to be update.
Caleb-Hurshman
force-pushed
the
feat/snowflake-exporter-rsa
branch
from
e23dfc5
to
8a82522
Compare
clayton-cornell
added
the
type/docs
PR Description
This PR updates the wrapped Snowflake exporter to match new config options to enable RSA key-pair authentication.
Which issue(s) this PR fixes
#10493
Notes to the Reviewer
PR Checklist