Skip to content

Commit 99fec9d

Browse files
authored
Merge pull request #208 from AWS-Joe-A/main
[fix]-consistent FAQ page experience
2 parents d8aad61 + 455d748 commit 99fec9d

File tree

5 files changed

+163
-112
lines changed

5 files changed

+163
-112
lines changed

docs/en/faq/adot.md

Lines changed: 41 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,44 @@
11
# AWS Distro for Open Telemetry (ADOT) - FAQ
22

3-
1. **Can I use the ADOT collector to ingest metrics into AMP?
4-
**Yes, this functionality was introduced with the GA launch for metrics support in May 2022 and you can use the ADOT collector from EC2, via our EKS add-on, via our ECS side-car integration, and/or via our Lambda layers.
5-
1. **Can I use the ADOT collector to collect logs and ingest them into Amazon CloudWatch or Amazon OpenSearch?**
6-
Not yet but we’re working on stabilizing logs upstream in OpenTelemetry and when the time comes, potentially later in 2023 or early 2024 we will support logs in ADOT, see also the [public roadmap entry](https://github.com/aws-observability/aws-otel-community/issues/11)
7-
1. **Where can I find resource usage and performance details on the ADOT collector?**
8-
We have a [Performance Report](https://aws-observability.github.io/aws-otel-collector/benchmark/report) online that we keep up to date as we release collectors.
9-
1. **Is it possible to use ADOT with Apache Kafka?**
10-
Yes, support to Kafka exporter and receiver was added in the ADOT collector v0.28.0. For more details, please check the [ADOT collector documentation](https://aws-otel.github.io/docs/components/kafka-receiver-exporter).
11-
1. **How can I configure the ADOT collector?**
12-
The ADOT collector is configured using YAML configuration files that are stored locally. Besides that, it is possible to use configuration stored in other locations, like S3 buckets. All the supported mechanisms to configure the ADOT collector are described in detail in the [ADOT collector documentation](https://aws-otel.github.io/docs/components/confmap-providers).
13-
1. **Can I do advanced sampling in the ADOT collector?**
14-
We’re working on it, please subscribe to the public [roadmap entry](https://github.com/aws-observability/aws-otel-collector/issues/1135) to keep up to date.
15-
1. **Any tips how to scale the ADOT collector?**
16-
Yes! See the upstream OpenTelemetry docs on [Scaling the Collector](https://opentelemetry.io/docs/collector/scaling/).
17-
1. **I have a fleet of ADOT collectors, how can I manage them?**
18-
This is an area of active development and we expect that it will mature in 2023, see the upstream OpenTelemetry docs on [Management](https://opentelemetry.io/docs/collector/management/) for more details, specifically on the [Open Agent Management Protocol (OpAMP)](https://opentelemetry.io/docs/collector/management/#opamp).
19-
1. **How do you monitor the health and performance of the ADOT collector?**
20-
1. [Monitoring the collector](https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/monitoring.md) - default metrics exposed on port 8080 that can be scraped by the Prometheus receiver
21-
2. Using the [Node Exporter](https://prometheus.io/docs/guides/node-exporter/), running node exporter would also provide several performance and health metrics about the node, pod, and operating system the collector is running in.
22-
3. [Kube-state-metrics (KSM)](https://github.com/kubernetes/kube-state-metrics), KSM can also produce interesting events about the collector.
23-
4. [Prometheus `up` metric](https://github.com/open-telemetry/opentelemetry-collector/pull/2918)
24-
5. A simple Grafana dashboard to get started: [https://grafana.com/grafana/dashboards/12553]()
25-
1. **Product FAQ** - [https://aws.amazon.com/otel/faqs/]()
3+
## Can I use the ADOT collector to ingest metrics into AMP?
4+
5+
Yes, this functionality was introduced with the GA launch for metrics support in May 2022 and you can use the ADOT collector from EC2, via our EKS add-on, via our ECS side-car integration, and/or via our Lambda layers.
6+
7+
## Can I use the ADOT collector to collect logs and ingest them into Amazon CloudWatch or Amazon OpenSearch?
8+
9+
Yes. [Log support](https://aws.amazon.com/about-aws/whats-new/2023/11/logs-support-aws-distro-opentelemetry/) has been available since Nov 22, 2023. You can view the [Logging Exporter](https://aws-otel.github.io/docs/components/misc-exporters) page for more details.
10+
11+
## Where can I find resource usage and performance details on the ADOT collector?
12+
13+
We have a [Performance Report](https://aws-observability.github.io/aws-otel-collector/benchmark/report) online that we keep up to date as we release collectors.
14+
15+
## Is it possible to use ADOT with Apache Kafka?
16+
17+
Yes, support to Kafka exporter and receiver was added in the ADOT collector v0.28.0. For more details, please check the [ADOT collector documentation](https://aws-otel.github.io/docs/components/kafka-receiver-exporter).
18+
.
19+
## How can I configure the ADOT collector?
20+
21+
The ADOT collector is configured using YAML configuration files that are stored locally. Besides that, it is possible to use configuration stored in other locations, like S3 buckets. All the supported mechanisms to configure the ADOT collector are described in detail in the [ADOT collector documentation](https://aws-otel.github.io/docs/components/confmap-providers).
22+
23+
## Can I do advanced sampling in the ADOT collector?
24+
25+
Yes. [Advanced Sampling](https://aws.amazon.com/about-aws/whats-new/2023/05/aws-distro-opentelemetry-advanced-sampling/) launched May 15, 2023. View the [Getting Started with Advanced Sampling using AWS Distro for OpenTelemetry](https://aws-otel.github.io/docs/getting-started/advanced-sampling) page for more details.
26+
27+
## Any tips how to scale the ADOT collector?
28+
29+
Yes! See the upstream OpenTelemetry docs on [Scaling the Collector](https://opentelemetry.io/docs/collector/scaling/).
30+
31+
## I have a fleet of ADOT collectors, how can I manage them?
32+
33+
This is an area of active development and we expect that it will mature in 2023, see the upstream OpenTelemetry docs on [Management](https://opentelemetry.io/docs/collector/management/) for more details, specifically on the [Open Agent Management Protocol (OpAMP)](https://opentelemetry.io/docs/collector/management/#opamp).
34+
35+
## How do you monitor the health and performance of the ADOT collector?
36+
37+
1. [Monitoring the collector](https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/monitoring.md) - default metrics exposed on port 8080 that can be scraped by the Prometheus receiver
38+
2. Using the [Node Exporter](https://prometheus.io/docs/guides/node-exporter/), running node exporter would also provide several performance and health metrics about the node, pod, and operating system the collector is running in.
39+
3. [Kube-state-metrics (KSM)](https://github.com/kubernetes/kube-state-metrics), KSM can also produce interesting events about the collector.
40+
4. [Prometheus `up` metric](https://github.com/open-telemetry/opentelemetry-collector/pull/2918)
41+
5. A simple Grafana dashboard to get started: [https://grafana.com/grafana/dashboards/12553]()
42+
43+
**Product FAQ:** [https://aws.amazon.com/otel/faqs/](https://aws.amazon.com/otel/faqs/)
2644

docs/en/faq/amg.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,58 @@
11
# Amazon Managed Grafana - FAQ
22

3-
**Why should I choose Amazon Managed Grafana?**
3+
## Why should I choose Amazon Managed Grafana?
44

55
**[High Availability](https://docs.aws.amazon.com/grafana/latest/userguide/disaster-recovery-resiliency.html)**: Amazon Managed Grafana workspaces are highly available with multi-az replication. Amazon Managed Grafana also continuously monitors for the health of workspaces and replaces unhealthy nodes, without impacting access to the workspaces. Amazon Managed Grafana manages the availability of compute and database nodes so customers don’t have to manage the infrastructure resources required for the administration & maintenance.
66

77
**[Data Security](https://docs.aws.amazon.com/grafana/latest/userguide/security.html)**: Amazon Managed Grafana encrypts the data at rest without any special configuration, third-party tools, or additional cost. [Data in-transit](https://docs.aws.amazon.com/grafana/latest/userguide/infrastructure-security.html) area also encrypted via TLS.
88

9-
**Which AWS regions are supported?**
9+
## Which AWS regions are supported?
1010

1111
Current list of supported Regions is available in the [Supported Regions section in the documentation.](https://docs.aws.amazon.com/grafana/latest/userguide/what-is-Amazon-Managed-Service-Grafana.html#AMG-supported-Regions)
1212

13-
**We have multiple AWS accounts in multiple regions in our Organization, does Amazon Managed Grafana work for these scenarios**
13+
## We have multiple AWS accounts in multiple regions in our Organization, does Amazon Managed Grafana work for these scenarios?
1414

1515
Amazon Managed Grafana integrates with [AWS Organizations](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html) to discover AWS accounts and resources in Organizational Units (OUs). With AWS Organizations customers can [centrally manage data source configuration and permission settings](https://docs.aws.amazon.com/grafana/latest/userguide/AMG-and-Organizations.html) for multiple AWS accounts.
1616

17-
**What data sources are supported in Amazon Managed Grafana?**
17+
## What data sources are supported in Amazon Managed Grafana?
1818

1919
Data sources are storage backends that customers can query in Grafana to build dashboards in Amazon Managed Grafana. Amazon Managed Grafana supports about [30+ built-in data sources](https://docs.aws.amazon.com/grafana/latest/userguide/AMG-data-sources-builtin.html) including AWS native services like Amazon CloudWatch, Amazon OpenSearch Service, AWS IoT SiteWise, AWS IoT TwinMaker, Amazon Managed Service for Prometheus, Amazon Timestream, Amazon Athena, Amazon Redshift, AWS X-Ray and many others. Additionally, [about 15+ other data sources](https://docs.aws.amazon.com/grafana/latest/userguide/AMG-data-sources-enterprise.html) are also available for upgraded workspaces in Grafana Enterprise.
2020

21-
**Data sources of my workloads are in private VPCs. How do I connect them to Amazon Managed Grafana securely?**
21+
## Data sources of my workloads are in private VPCs. How do I connect them to Amazon Managed Grafana securely?
2222

2323
Private [data sources within a VPC](https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-vpc.html) can be connected to Amazon Managed Grafana through AWS PrivateLink to keep the traffic secure. Further access control to Amazon Managed Grafana service from the [VPC endpoints](https://docs.aws.amazon.com/grafana/latest/userguide/AMG-configure-nac.html) can be restricted by attaching an [IAM resource policy](https://docs.aws.amazon.com/grafana/latest/userguide/VPC-endpoints.html#controlling-vpc) for [Amazon VPC endpoints](https://docs.aws.amazon.com/whitepapers/latest/aws-privatelink/what-are-vpc-endpoints.html).
2424

25-
**What User Authentication mechanism is available in Amazon Managed Grafana?**
25+
## What User Authentication mechanism is available in Amazon Managed Grafana?
2626

2727
In Amazon Managed Grafana workspace, [users are authenticated to the Grafana console](https://docs.aws.amazon.com/grafana/latest/userguide/authentication-in-AMG.html) by single sign-on using any IDP that supports Security Assertion Markup Language 2.0 (SAML 2.0) or AWS IAM Identity Center (successor to AWS Single Sign-On).
2828

2929
> Related blog: [Fine-grained access control in Amazon Managed Grafana using Grafana Teams](https://aws.amazon.com/blogs/mt/fine-grained-access-control-in-amazon-managed-grafana-using-grafana-teams/)
3030
31-
**What kind of automation support is available for Amazon Managed Grafana?**
31+
## What kind of automation support is available for Amazon Managed Grafana?
3232

3333
Amazon Managed Grafana is [integrated with AWS CloudFormation](https://docs.aws.amazon.com/grafana/latest/userguide/creating-resources-with-cloudformation.html), which helps customers in modeling and setting up AWS resources so that customers can spend less time creating and managing resources and infrastructure in AWS. With [AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html) customers can reuse templates to set up Amazon Managed Grafana resources consistently and repeatedly. Amazon Managed Grafana also has [API](https://docs.aws.amazon.com/grafana/latest/APIReference/Welcome.html)available which supports customers in automating through [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html) or integrating with software/products. Amazon Managed Grafana workspaces has [HTTP APIs](https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html) for automation and integration support.
3434

3535
> Related blog: [Announcing Private VPC data source support for Amazon Managed Grafana](https://aws.amazon.com/blogs/mt/announcing-private-vpc-data-source-support-for-amazon-managed-grafana/)
3636
37-
**My Organization uses Terraform for automation. Does Amazon Managed Grafana support Terraform?**
37+
## My Organization uses Terraform for automation. Does Amazon Managed Grafana support Terraform?
3838
Yes, [Amazon Managed Grafana supports](https://aws-observability.github.io/observability-best-practices/recipes/recipes/amg-automation-tf/) Terraform for [automation](https://registry.terraform.io/modules/terraform-aws-modules/managed-service-grafana/aws/latest)
3939

4040
> Example: [Reference implementation for Terraform support](https://github.com/aws-observability/terraform-aws-observability-accelerator/tree/main/examples/managed-grafana-workspace)
4141
42-
**I am using commonly used Dashboards in my current Grafana setup. Is there a way to use them on Amazon Managed Grafana rather than re-creating again?**
42+
## I am using commonly used Dashboards in my current Grafana setup. Is there a way to use them on Amazon Managed Grafana rather than re-creating again?
4343

4444
Amazon Managed Grafana supports [HTTP APIs](https://docs.aws.amazon.com/grafana/latest/userguide/Using-Grafana-APIs.html) that allow you to easily automate deployment and management of Dashboards, users and much more. You can use these APIs in your GitOps/CICD processes to automate management of these resources.
4545

46-
**Does Amazon Managed Grafana support Alerts?**
46+
## Does Amazon Managed Grafana support Alerts?
4747

4848
[Amazon Managed Grafana alerting](https://docs.aws.amazon.com/grafana/latest/userguide/alerts-overview.html) provides customers with robust and actionable alerts that help learn about problems in the systems in near real time, minimizing disruption to services. Grafana includes access to an updated alerting system, Grafana alerting, that centralizes alerting information in a single, searchable view.
4949

50-
**My Organization requires all actions be recorded for audits. Can Amazon Managed Grafana events be recorded?**
50+
## My Organization requires all actions be recorded for audits. Can Amazon Managed Grafana events be recorded?
5151

5252
Amazon Managed Grafana is integrated with [AWS CloudTrail](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html), which provides a record of actions taken by a user, a role, or an AWS service in Amazon Managed Grafana. CloudTrail captures all [API calls for Amazon Managed Grafana](https://docs.aws.amazon.com/grafana/latest/userguide/logging-using-cloudtrail.html)as events. The calls that are captured include calls from the Amazon Managed Grafana console and code calls to the Amazon Managed Grafana API operations.
5353

54-
**What more information is available?**
54+
## What additional information is available?
5555

5656
For additional information on Amazon Managed Grafana customers can read the AWS [Documentation](https://docs.aws.amazon.com/grafana/latest/userguide/what-is-Amazon-Managed-Service-Grafana.html), go through the AWS Observability Workshop on [Amazon Managed Grafana](https://catalog.workshops.aws/observability/en-US/aws-managed-oss/amg) and also check the [product page](https://aws.amazon.com/grafana/) to know the [features](https://aws.amazon.com/grafana/features/?nc=sn&loc=2), [pricing](https://aws.amazon.com/grafana/pricing/?nc=sn&loc=3) details, latest [blog posts](https://aws.amazon.com/grafana/resources/?nc=sn&loc=4&msg-blogs.sort-by=item.additionalFields.createdDate&msg-blogs.sort-order=desc#Latest_blog_posts) and [videos](https://aws.amazon.com/grafana/resources/?nc=sn&loc=4&msg-blogs.sort-by=item.additionalFields.createdDate&msg-blogs.sort-order=desc#Videos).
5757

58-
**Product FAQ** [https://aws.amazon.com/grafana/faqs/](https://aws.amazon.com/grafana/faqs/)
58+
**Product FAQ:** [https://aws.amazon.com/grafana/faqs/](https://aws.amazon.com/grafana/faqs/)

0 commit comments

Comments
 (0)