Skip to content

Commit

Permalink
addressing PR feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
freschri committed Aug 3, 2023
1 parent 44f10e9 commit 8c7ff7f
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/linkcheck.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
{ "pattern": "https://sqs" },
{ "pattern": "www.rsa-2048.example.com" },
{ "pattern": "rsa-2048.example.com" },
{ "pattern": "https://ingress-red-saas.instana.io/" }
{ "pattern": "https://ingress-red-saas.instana.io/" },
{ "pattern": "http://console-eks.yourdomain.com/" }
]
}
14 changes: 7 additions & 7 deletions docs/addons/amp-addon.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ For more information on the add-on, please review the [user guide](https://docs.

This add-on can used with four different patterns :

Pattern # 1 : Simple and Easy - Using all default property values. This pattern creates a new AMP workspace with default property values such as `workspaceName`, `namespace` with no tags on the AMP workspace and deploys an ADOT collector in the `default` namespace with `deployment` as the mode to remote write metrics to AMP workspace.
Pattern #1: Simple and Easy - Using all default property values. This pattern creates a new AMP workspace with default property values such as `workspaceName`, `namespace` with no tags on the AMP workspace and deploys an ADOT collector in the `default` namespace with `deployment` as the mode to remote write metrics to AMP workspace.

```typescript
import * as cdk from 'aws-cdk-lib';
Expand All @@ -30,7 +30,7 @@ const blueprint = blueprints.EksBlueprint.builder()
.build(app, 'my-stack-name');
```

Pattern # 2 : Overriding property values for Name and Tags for a custom AMP Workspace name and tags. This pattern creates a new AMP workspace with property values passed on such as `workspaceName`, `tags` and deploys an ADOT collector on the namespace specified in `namespace` with name in `name` and `deployment` as the mode to remote write metrics to AMP workspace.
Pattern #2: Overriding property values for Name and Tags for a custom AMP Workspace name and tags. This pattern creates a new AMP workspace with property values passed on such as `workspaceName`, `tags` and deploys an ADOT collector on the namespace specified in `namespace` with name in `name` and `deployment` as the mode to remote write metrics to AMP workspace.

```typescript
import * as cdk from 'aws-cdk-lib';
Expand Down Expand Up @@ -66,7 +66,7 @@ const blueprint = blueprints.EksBlueprint.builder()
}))
.build(app, 'my-stack-name');
```
Pattern # 3 : Passing on AMP Remote Endpoint of an existing AMP workspace to be used to remote write metrics. This pattern does not create an AMP workspace. Deploys an ADOT collector on the namespace specified in `namespace` with name in `name` and `deployment` as the mode to remote write metrics to AMP workspace of the URL passed as input. This pattern ignores any other property values passed if `ampPrometheusEndpoint` is present.
Pattern #3: Passing on AMP Remote Endpoint of an existing AMP workspace to be used to remote write metrics. This pattern does not create an AMP workspace. Deploys an ADOT collector on the namespace specified in `namespace` with name in `name` and `deployment` as the mode to remote write metrics to AMP workspace of the URL passed as input. This pattern ignores any other property values passed if `ampPrometheusEndpoint` is present.

```typescript
import * as cdk from 'aws-cdk-lib';
Expand All @@ -88,7 +88,7 @@ const blueprint = blueprints.EksBlueprint.builder()
.build(app, 'my-stack-name');
```

Pattern # 4 : Overriding property values for different deployment Modes. This pattern creates a new AMP workspace with property values passed on such as `workspaceName`, `tags` and deploys an ADOT collector on the namespace specified in `namespace` with name in `name` and `daemonset` as the mode to remote write metrics to AMP workspace. Deployment modes can be overridden to any of these values - `deployment`, `daemonset`, `statefulset`, `sidecar`.
Pattern #4: Overriding property values for different deployment Modes. This pattern creates a new AMP workspace with property values passed on such as `workspaceName`, `tags` and deploys an ADOT collector on the namespace specified in `namespace` with name in `name` and `daemonset` as the mode to remote write metrics to AMP workspace. Deployment modes can be overridden to any of these values - `deployment`, `daemonset`, `statefulset`, `sidecar`.

```typescript
import * as cdk from 'aws-cdk-lib';
Expand Down Expand Up @@ -128,7 +128,7 @@ const blueprint = blueprints.EksBlueprint.builder()
.build(app, 'my-stack-name');
```

Pattern # 5 : Configuring rules into AMP. This pattern creates recording rules and/or alerting rules, based on the YAML files provided. A workspace ARN is also required as input.
Pattern #5: Configuring rules into AMP. This pattern creates recording rules and/or alerting rules, based on the YAML files provided. A workspace ARN is also required as input.

```typescript
import * as cdk from 'aws-cdk-lib';
Expand Down Expand Up @@ -175,7 +175,7 @@ groups:
An example of rules configuration can be found in the data section of the [EKS monitoring rules file](https://github.com/aws-observability/terraform-aws-observability-accelerator/blob/main/modules/eks-monitoring/rules.tf) in the aws-observability repository.
Pattern # 6 : Configuring the [AWS Distro for OpenTelemetry Collector](https://aws-otel.github.io/docs/getting-started/collector). This pattern enables you to configure the Collector by providing a manifest describing an OpenTelemetryCollector resource:
Pattern #6: Configuring the [AWS Distro for OpenTelemetry Collector](https://aws-otel.github.io/docs/getting-started/collector). This pattern enables you to configure the Collector by providing a manifest describing an OpenTelemetryCollector resource:
```yaml
apiVersion: opentelemetry.io/v1alpha1
Expand All @@ -191,7 +191,7 @@ spec:
{{javaPrometheusMetricsEndpoint}}
```
This pattern is useful when you need to customise the configuration of the OpenTelemetryCollector, e.g. to add specific scraping targets and parameters in the Prometheus receiver configuration, for a job capturing metrics of a Java workload.
This pattern is useful when you need to customize the configuration of the OpenTelemetryCollector, e.g. to add specific scraping targets and parameters in the Prometheus receiver configuration, for a job capturing metrics of a Java workload.
The optional `openTelemetryCollector.manifestParameterMap` parameter allows you to define a map where the keys can be used (in double curly braces) within the OpenTelemetryCollector manifest as e.g. {{javaScrapeSampleLimit}}, to be replaced by the corresponding values.

Expand Down

0 comments on commit 8c7ff7f

Please sign in to comment.