Repository navigation
Publish a JSON schema of the config #1219
Description
Having a JSON schema for the config format would be a lot more convenient than the current format of the docs: https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Agent-Configuration-File-Details.html
It would have the following advantages:
- Probably easier to read than the docs IMO
- It's a better specified and completely unambiguous documentation format
- If we're generating config with our own code we could validate that it's correct before passing it to CloudWatch Agent
- We could generate TypeScript types etc. from a JSON schema
Activity
okankoAMZ commentedon Jul 18, 2024
Hi!
If I understand correctly, you want to add a rule schema to our JSON configurations to make config generation easier? If you would like I can create a feature request for that.
Please let me know if you have any other questions
jedwards1211 commentedon Jul 18, 2024
I'm not sure what you mean by rule schema, I'm asking you to make a JSON Schema document available at some URL under AWS that specifies the schema of the JSON cloudwatch agent config. And anytime the config format is extended/changed, make a new JSON Schema for it available under a new URL containing a config version number of some kind.
jedwards1211 commentedon Jul 18, 2024
So to be clear something like
GET https://docs.aws.amazon.com/AmazonCloudWatch/config-schema/<version>/schema.jsonresponds withContent-Type: application/jsonand body (incomplete example):{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://docs.aws.amazon.com/AmazonCloudWatch/config-schema/latest/schema.json", "type": "object", "properties": { "agent": { "type": "object", "properties": { "metrics_collection_interval": {"type": "number"}, }, "additionalProperties": false } }, "additionalProperties": false }And then links to these URLs in the documentation pages.
okankoAMZ commentedon Jul 18, 2024
I see , so you want us to have our schema.json found here to be in our documentation?
jedwards1211 commentedon Jul 18, 2024
Oh, sorry I wasn't aware of the existence of that. I tend to be rushing to get deployments working and I missed the mention of that in the docs.
jedwards1211 commentedon Jul 18, 2024
Oh wait. The docs at https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Agent-Configuration-File-Details.html only say:
That's why I wasn't aware of the schema in this repo.
It would have helped me if there were a link in that page to https://github.com/aws/amazon-cloudwatch-agent/blob/main/translator/config/schema.json so that I could view it without going into an instance with CloudWatch agent installed.
okankoAMZ commentedon Jul 19, 2024
I understand, I will create an action item in our backlog to consider this change. Thank you for bringing this up.