Skip to content
This repository was archived by the owner on Mar 12, 2026. It is now read-only.

Commit 46ec972

Browse files
author
Albin Kerouanton
authored
Add missing docs for FORCE_HIGH_RES param (#33)
1 parent d28e9f2 commit 46ec972

File tree

2 files changed

+87
-39
lines changed

2 files changed

+87
-39
lines changed

README.md

Lines changed: 86 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,43 @@
1-
<!-- This file was automatically generated by the `build-harness`. Make all changes to `README.yaml` and run `make readme` to rebuild this file. -->
1+
<!--
2+
3+
4+
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
** DO NOT EDIT THIS FILE
17+
**
18+
** This file was automatically generated by the `build-harness`.
19+
** 1) Make all changes to `README.yaml`
20+
** 2) Run `make init` (you only need to do this once)
21+
** 3) Run`make readme` to rebuild this file.
22+
**
23+
** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.)
24+
**
25+
26+
27+
28+
29+
30+
31+
32+
33+
34+
35+
36+
37+
38+
39+
40+
-->
241
[![README Header][readme_header_img]][readme_header_link]
342

443
[![Cloud Posse][logo]](https://cpco.io/homepage)
@@ -70,6 +109,7 @@ Command-line arguments take precedence over ENV vars
70109
| exclude_metrics | EXCLUDE_METRICS | Never publish the specified metrics (comma-separated list of glob patterns) |
71110
| include_dimensions_for_metrics | INCLUDE_DIMENSIONS_FOR_METRICS | Only publish the specified dimensions for metrics (semi-colon-separated key values of comma-separated dimensions of METRIC=dim1,dim2;, e.g. 'flink_jobmanager=job_id') |
72111
| exclude_dimensions_for_metrics | EXCLUDE_DIMENSIONS_FOR_METRICS | Never publish the specified dimensions for metrics (semi-colon-separated key values of comma-separated dimensions of METRIC=dim1,dim2;, e.g. 'flink_jobmanager=job,host;zk_up=host,pod;') |
112+
| force_high_res | FORCE_HIGH_RES | Whether publish all metrics with high resolution to Cloudwatch or only those labeled with `__cw_high_res`. |
73113

74114

75115
__NOTE__: If AWS credentials are not provided in the command-line arguments (`aws_access_key_id` and `aws_secret_access_key`)
@@ -211,38 +251,47 @@ Check out these related projects.
211251

212252
## Help
213253

214-
**Got a question?**
254+
**Got a question?** We got answers.
215255

216256
File a GitHub [issue](https://github.com/cloudposse/prometheus-to-cloudwatch/issues), send us an [email][email] or join our [Slack Community][slack].
217257

218258
[![README Commercial Support][readme_commercial_support_img]][readme_commercial_support_link]
219259

220-
## Commercial Support
260+
## DevOps Accelerator for Startups
221261

222-
Work directly with our team of DevOps experts via email, slack, and video conferencing.
223262

224-
We provide [*commercial support*][commercial_support] for all of our [Open Source][github] projects. As a *Dedicated Support* customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.
263+
We are a [**DevOps Accelerator**][commercial_support]. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
225264

226-
[![E-Mail](https://img.shields.io/badge/email-hello@cloudposse.com-blue.svg)][email]
227-
228-
- **Questions.** We'll use a Shared Slack channel between your team and ours.
229-
- **Troubleshooting.** We'll help you triage why things aren't working.
230-
- **Code Reviews.** We'll review your Pull Requests and provide constructive feedback.
231-
- **Bug Fixes.** We'll rapidly work to fix any bugs in our projects.
232-
- **Build New Terraform Modules.** We'll [develop original modules][module_development] to provision infrastructure.
233-
- **Cloud Architecture.** We'll assist with your cloud strategy and design.
234-
- **Implementation.** We'll provide hands-on support to implement our reference architectures.
265+
[![Learn More](https://img.shields.io/badge/learn%20more-success.svg?style=for-the-badge)][commercial_support]
235266

267+
Work directly with our team of DevOps experts via email, slack, and video conferencing.
236268

269+
We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
237270

271+
- **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.
272+
- **Release Engineering.** You'll have end-to-end CI/CD with unlimited staging environments.
273+
- **Site Reliability Engineering.** You'll have total visibility into your apps and microservices.
274+
- **Security Baseline.** You'll have built-in governance with accountability and audit logs for all changes.
275+
- **GitOps.** You'll be able to operate your infrastructure via Pull Requests.
276+
- **Training.** You'll receive hands-on training so your team can operate what we build.
277+
- **Questions.** You'll have a direct line of communication between our teams via a Shared Slack channel.
278+
- **Troubleshooting.** You'll get help to triage when things aren't working.
279+
- **Code Reviews.** You'll receive constructive feedback on Pull Requests.
280+
- **Bug Fixes.** We'll rapidly work with you to fix any bugs in our projects.
238281

239282
## Slack Community
240283

241284
Join our [Open Source Community][slack] on Slack. It's **FREE** for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally *sweet* infrastructure.
242285

243286
## Newsletter
244287

245-
Signup for [our newsletter][newsletter] that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
288+
Sign up for [our newsletter][newsletter] that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
289+
290+
## Office Hours
291+
292+
[Join us every Wednesday via Zoom][office_hours] for our weekly "Lunch & Learn" sessions. It's **FREE** for everyone!
293+
294+
[![zoom](https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png")][office_hours]
246295

247296
## Contributing
248297

@@ -267,7 +316,7 @@ In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
267316

268317
## Copyright
269318

270-
Copyright © 2017-2019 [Cloud Posse, LLC](https://cpco.io/copyright)
319+
Copyright © 2017-2020 [Cloud Posse, LLC](https://cpco.io/copyright)
271320

272321

273322

@@ -338,33 +387,31 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
338387
[austince_homepage]: https://github.com/austince
339388
[austince_avatar]: https://img.cloudposse.com/150x150/https://github.com/austince.png
340389

341-
342-
343390
[![README Footer][readme_footer_img]][readme_footer_link]
344391
[![Beacon][beacon]][website]
345392

346393
[logo]: https://cloudposse.com/logo-300x69.svg
347-
[docs]: https://cpco.io/docs
348-
[website]: https://cpco.io/homepage
349-
[github]: https://cpco.io/github
350-
[jobs]: https://cpco.io/jobs
351-
[hire]: https://cpco.io/hire
352-
[slack]: https://cpco.io/slack
353-
[linkedin]: https://cpco.io/linkedin
354-
[twitter]: https://cpco.io/twitter
355-
[testimonial]: https://cpco.io/leave-testimonial
356-
[newsletter]: https://cpco.io/newsletter
357-
[email]: https://cpco.io/email
358-
[commercial_support]: https://cpco.io/commercial-support
359-
[we_love_open_source]: https://cpco.io/we-love-open-source
360-
[module_development]: https://cpco.io/module-development
361-
[terraform_modules]: https://cpco.io/terraform-modules
362-
[readme_header_img]: https://cloudposse.com/readme/header/img?repo=cloudposse/prometheus-to-cloudwatch
363-
[readme_header_link]: https://cloudposse.com/readme/header/link?repo=cloudposse/prometheus-to-cloudwatch
364-
[readme_footer_img]: https://cloudposse.com/readme/footer/img?repo=cloudposse/prometheus-to-cloudwatch
365-
[readme_footer_link]: https://cloudposse.com/readme/footer/link?repo=cloudposse/prometheus-to-cloudwatch
366-
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img?repo=cloudposse/prometheus-to-cloudwatch
367-
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?repo=cloudposse/prometheus-to-cloudwatch
394+
[docs]: https://cpco.io/docs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/prometheus-to-cloudwatch&utm_content=docs
395+
[website]: https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/prometheus-to-cloudwatch&utm_content=website
396+
[github]: https://cpco.io/github?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/prometheus-to-cloudwatch&utm_content=github
397+
[jobs]: https://cpco.io/jobs?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/prometheus-to-cloudwatch&utm_content=jobs
398+
[hire]: https://cpco.io/hire?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/prometheus-to-cloudwatch&utm_content=hire
399+
[slack]: https://cpco.io/slack?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/prometheus-to-cloudwatch&utm_content=slack
400+
[linkedin]: https://cpco.io/linkedin?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/prometheus-to-cloudwatch&utm_content=linkedin
401+
[twitter]: https://cpco.io/twitter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/prometheus-to-cloudwatch&utm_content=twitter
402+
[testimonial]: https://cpco.io/leave-testimonial?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/prometheus-to-cloudwatch&utm_content=testimonial
403+
[office_hours]: https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/prometheus-to-cloudwatch&utm_content=office_hours
404+
[newsletter]: https://cpco.io/newsletter?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/prometheus-to-cloudwatch&utm_content=newsletter
405+
[email]: https://cpco.io/email?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/prometheus-to-cloudwatch&utm_content=email
406+
[commercial_support]: https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/prometheus-to-cloudwatch&utm_content=commercial_support
407+
[we_love_open_source]: https://cpco.io/we-love-open-source?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/prometheus-to-cloudwatch&utm_content=we_love_open_source
408+
[terraform_modules]: https://cpco.io/terraform-modules?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/prometheus-to-cloudwatch&utm_content=terraform_modules
409+
[readme_header_img]: https://cloudposse.com/readme/header/img
410+
[readme_header_link]: https://cloudposse.com/readme/header/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/prometheus-to-cloudwatch&utm_content=readme_header_link
411+
[readme_footer_img]: https://cloudposse.com/readme/footer/img
412+
[readme_footer_link]: https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/prometheus-to-cloudwatch&utm_content=readme_footer_link
413+
[readme_commercial_support_img]: https://cloudposse.com/readme/commercial-support/img
414+
[readme_commercial_support_link]: https://cloudposse.com/readme/commercial-support/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/prometheus-to-cloudwatch&utm_content=readme_commercial_support_link
368415
[share_twitter]: https://twitter.com/intent/tweet/?text=prometheus-to-cloudwatch&url=https://github.com/cloudposse/prometheus-to-cloudwatch
369416
[share_linkedin]: https://www.linkedin.com/shareArticle?mini=true&title=prometheus-to-cloudwatch&url=https://github.com/cloudposse/prometheus-to-cloudwatch
370417
[share_reddit]: https://reddit.com/submit/?url=https://github.com/cloudposse/prometheus-to-cloudwatch

README.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ usage: |-
6464
| exclude_metrics | EXCLUDE_METRICS | Never publish the specified metrics (comma-separated list of glob patterns) |
6565
| include_dimensions_for_metrics | INCLUDE_DIMENSIONS_FOR_METRICS | Only publish the specified dimensions for metrics (semi-colon-separated key values of comma-separated dimensions of METRIC=dim1,dim2;, e.g. 'flink_jobmanager=job_id') |
6666
| exclude_dimensions_for_metrics | EXCLUDE_DIMENSIONS_FOR_METRICS | Never publish the specified dimensions for metrics (semi-colon-separated key values of comma-separated dimensions of METRIC=dim1,dim2;, e.g. 'flink_jobmanager=job,host;zk_up=host,pod;') |
67+
| force_high_res | FORCE_HIGH_RES | Whether publish all metrics with high resolution to Cloudwatch or only those labeled with `__cw_high_res`. |
6768
6869
6970
__NOTE__: If AWS credentials are not provided in the command-line arguments (`aws_access_key_id` and `aws_secret_access_key`)

0 commit comments

Comments
 (0)