feat: Add new stdlib function to_json #2860
Conversation
ravishankar15
requested review from
clayton-cornell and
a team
as code owners
| `encoding.to_json` fails if the map argument provided can't be parsed as json string. | ||
|
|
||
| A common use case of `encoding.to_json` is to encode a config of component which is expected to be a JSON | ||
| For example, `config` of a [`prometheus.exporter.blackbox`][] |
There was a problem hiding this comment.
| For example, `config` of a [`prometheus.exporter.blackbox`][] | |
| For example, configuration of a [`prometheus.exporter.blackbox`][] |
Missing a word here... a prometheus.exporter.blackbox string?
There was a problem hiding this comment.
I wanted to refer the param name in the component updated accordingly.
ravishankar15
force-pushed
the
stdlib-to-json
branch
from
a6e6e48 to
7ce2113
Compare
Fix documentation remove test
ravishankar15
force-pushed
the
stdlib-to-json
branch
from
7ce2113 to
7189840
Compare
There was a problem hiding this comment.
LGTM, thanks! Over to @clayton-cornell for another doc review
| `encoding.to_json` fails if the input argument provided can't be parsed as JSON string. | ||
|
|
||
| A common use case for `encoding.to_json` is to encode a configuration of component which is expected to be a JSON string | ||
| For example, `config` param of [`prometheus.exporter.blackbox`][] |
There was a problem hiding this comment.
| For example, `config` param of [`prometheus.exporter.blackbox`][] | |
| For example, `config` param of [`prometheus.exporter.blackbox`][]. |
I'm not sure what "config param" means in this context.
Can this be reworked as:
For example, a configuration parameter in [prometheus.exporter.blackbox][].
Does this mean the same thing?
There was a problem hiding this comment.
prometheus.exporter.blackbox component accepts a argument called config which is expected to be a JSON string. May be changing the word param can be more appropriate I believe. https://grafana.com/docs/alloy/latest/reference/components/prometheus/prometheus.exporter.blackbox/#arguments
clayton-cornell
added
the
type/docs
PR Description
Adds a new stdlib function for json encoding
to_jsonwhich converts a map to JSONWhich issue(s) this PR fixes
Fixes #152
Notes to the Reviewer
PR Checklist