Skip to content

Minor Updates to ECS-EC2 windows Doc and Template #140

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Minor Updates to ECS-EC2 windows Doc and Template #140

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
34ae2be
minor documentation updates
daidokoro May 22, 2024
64271ee
changlog
daidokoro May 22, 2024
2361d1f
updated hardcoded image version in template
daidokoro May 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions opentelemetry/ecs-ec2-windows/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,10 @@
<!-- ### version / full date -->
<!-- * [Update/Bug fix] message that describes the changes that you apply -->


### 0.0.1 / 2024-05-22
* Minor documentation updates
* Updated hardcoded template value for the otel image used in the OtelConfig parameter

### 0.0.1 / 2023-09-11
* Added EC2 ECS Windows Example for metrics collection
9 changes: 5 additions & 4 deletions opentelemetry/ecs-ec2-windows/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This template section provides an example template for deployin the Open Telemet
| Parameter | Description | Default Value | Required |
|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------|--------------------|
| ClusterName | The name of an **existing** ECS Cluster | | :heavy_check_mark: |
| OTelImage | The open telemtry collector container image.<br><br>ECR Images must be prefixed with the ECR image URI. For eg. `<AccountID>.dkr.ecr.<REGION>.amazonaws.com/image:tag` | coralogixrepo/otel-coralogix-ecs-ec2 | |
| OTelImage | The open telemtry collector container image.<br><br>ECR Images must be prefixfd with the ECR image URI. For eg. `<AccountID>.dkr.ecr.<REGION>.amazonaws.com/image:tag` | coralogixrepo/otel-coralogix-ecs-ec2 | |
| AppImage | Your windows application container image | | |
| CoralogixRegion | The region of your Coralogix Account | *Allowed Values:*<br>- Europe<br>- Europe2<br>- India<br>- Singapore<br>- US | :heavy_check_mark: |
| ApplicationName | You application name | | :heavy_check_mark: |
Expand All @@ -26,7 +26,7 @@ This template section provides an example template for deployin the Open Telemet

### How it works

This deployment uses the the [awsecscontainermetricsd](../ecs-ec2/components.md#aws-ecs-container-metrics-daemonset-receiver) receiver by Coralogix, to collect metrics from Windows application. For windows deployments the receiver must be deployed in Sidecar mode.
This deployment uses the [awsecscontainermetricsd](../ecs-ec2/components.md#aws-ecs-container-metrics-daemonset-receiver) receiver by Coralogix, to collect metrics from Windows applications. For windows deployments the receiver must be deployed in Sidecar mode.

```yaml
receivers:
Expand All @@ -40,8 +40,9 @@ For Windows, this receiver does not support being run as a daemonset, as such, e

### Open Telemetry Configuration

The Open Telemetry configuration is embedded in this cloudformation template by default, however, you do have the option of specifying your own configuration my modifying the template. The The Coralogix Open Telemetry distribution supports reading configration from S3 as well as an Envrionmentat Variable. Note that Environment variables can be raw strings or Base64 encoded. Configuration from S3 must be passed to the collector using the S3 URL of the object, for example `cdot --config s3://{your-bucket}.s3.{region}.amazonaws.com/{your-object-key}`, when using this feature in ECS, the host or task must have sufficient permissions to read S3 Objects.
The Open Telemetry configuration is embedded in this CloudFormation template by default. However, you have the option of specifying your own configuration by modifying the template. The Coralogix Open Telemetry distribution supports reading configuration from S3 as well as from an Environment Variable. Note that environment variables can be raw strings or Base64 encoded. Configuration from S3 must be passed to the collector using the S3 URL of the object. For example: cdot --config `s3://{your-bucket}.s3.{region}.amazonaws.com/{your-object-key}`. When using this feature in ECS, the host or task must have sufficient permissions to read S3 objects.

### Image

This example uses the [coralogixrepo/coralogix-otel-collector:0.1.0-windowsserver-1809](https://hub.docker.com/layers/coralogixrepo/coralogix-otel-collector/0.1.0-windowsserver-1809/images/sha256-c436b2b29501592449e2b72a2393f4825e7216bdd62d90cb5e14463a46fafd95?context=explore) image which is a custom distribution of Open Telemetry containing custom components developed by Coralogix. The image is available on [Docker Hub](https://hub.docker.com/r/coralogixrepo/coralogix-otel-collector). The ECS components are described [here](../ecs-ec2/components.md)
This example uses the _windows-server-1809_ tagged version of the [coralogixrepo/coralogix-otel-collector](https://hub.docker.com/r/coralogixrepo/coralogix-otel-collector/tags) image which is a custom distribution of Open Telemetry containing custom components developed by Coralogix. The image is available on [Docker Hub](https://hub.docker.com/r/coralogixrepo/coralogix-otel-collector). The ECS components are described [here](../ecs-ec2/components.md)

2 changes: 1 addition & 1 deletion opentelemetry/ecs-ec2-windows/template.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Parameters:

OtelImage:
Type: String
Default: coralogixrepo/coralogix-otel-collector:0.1.0-windowsserver-1809
Default: coralogixrepo/coralogix-otel-collector:0.2.10-windowsserver-1809

PrivateKey:
Type: String
Expand Down