https://github.com/terraform-ibm-modules/terraform-ibm-atracker
This module is used to send AT events to ATracker instead of LogDNA, so that ATracker can forward the events to COS
https://github.com/terraform-ibm-modules/terraform-ibm-atracker
activitytracker atracker observability
Last synced: 5 months ago
JSON representation
This module is used to send AT events to ATracker instead of LogDNA, so that ATracker can forward the events to COS
- Host: GitHub
- URL: https://github.com/terraform-ibm-modules/terraform-ibm-atracker
- Owner: terraform-ibm-modules
- License: apache-2.0
- Created: 2021-12-09T10:02:18.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-27T08:53:47.000Z (over 2 years ago)
- Last Synced: 2023-03-03T23:23:38.580Z (about 2 years ago)
- Topics: activitytracker, atracker, observability
- Language: HCL
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IBM Cloud ATracker - Terraform Module
This module is used to send AT events to ATracker instead of LogDNA, so that ATracker can forward the events to COS. This gives you the visibility into the performance and health of your resources on IBM Cloud. It differs from other observability services by AT events being separated from log events (double agent) and AT events sent to a new ATracker URL.
Atracker module provision:
- Atracker
# Compatibility
This module is meant to use with Terraform 0.13 (and higher)
# Example Usage
Examples found in [examples folder](https://github.ibm.com/slz-v2-poc/terraform-atracker-module/tree/master/Examples).
```
provider "ibm" {
}
data "ibm_resource_group" "cos_group" {
name = var.resource_group
}
module "cos" {
source = "terraform-ibm-modules/cos/ibm//modules/instance"
version = "1.4.1"
service_name = var.prefix != null ? "${var.prefix}-${var.service_name}" : var.service_name
plan = var.plan
region = var.region
resource_group_id = data.ibm_resource_group.cos_group.id
parameters = var.parameters
bind_resource_key = var.bind_resource_key
resource_key_name = var.resource_key_name
key_parameters = var.key_parameters
role = var.role
}
module "cos_bucket" {
source = "terraform-ibm-modules/cos/ibm//modules/bucket"
version = "1.4.1"
bucket_name = var.prefix != null ? "${var.prefix}-${var.bucket_name}" : var.bucket_name
cos_instance_id = module.cos.cos_instance_id
location = var.location
storage_class = var.storage_class
force_delete = var.force_delete
endpoint_type = var.endpoint_type
kms_key_crn = var.kms_key_crn
expire_rules = var.expire_rules
}
module "atracker" {
//Uncomment link below line to make it point to registry level
//source = "terraform-ibm-modules/atracker/ibm"
source = "../.."
resource_group = var.resource_group
bucket_name = var.bucket_name
location = var.location
target_crn = module.cos.cos_instance_id
api_key = module.cos.cos_key_credentials.apikey #pragma: allowlist secret`
}
```
# Atrcker Inputs
| Name | Description | Type | Default | Required |
|-------------|------------------|---------|---------|----------|
|atracker_target_name| Name of the atracker target. Default will be atracker-target- | string | null | no |
|atracker_target_type | Target type for atracker | string | cloud_object_storage | yes |
|atracker_route_name | Name of the atracker route. Default will be atracker-route- | string| null | no |
|receive_global_events | Name of the atracker route. Default will be atracker-route- | bool | true | yes
# Atrcker Outputs
| Name | Description |
|-------------|------------------|
|atracker_route_id| The ID of the atracker route |
|atracker_target_crn | The CRN of atracker target |
## Requirements
### Terraform plugins
- [Terraform](https://www.terraform.io/downloads.html) 0.13 (or later)
- [terraform-provider-ibm](https://github.com/IBM-Cloud/terraform-provider-ibm)
## Install
### Terraform
Be sure you have the correct Terraform version (0.13), you can choose the binary here:
- https://releases.hashicorp.com/terraform/
### Terraform plugins
Be sure you have the compiled plugins on $HOME/.terraform.d/plugins/
- [terraform-provider-ibm](https://github.com/IBM-Cloud/terraform-provider-ibm)
### Pre-commit hooks
Run the following command to execute the pre-commit hooks defined in .pre-commit-config.yaml file
```
pre-commit run -a
```
You can install pre-coomit tool using
```
pip install pre-commit
```
or
```
pip3 install pre-commit
```
## How to input varaible values through a file
To review the plan for the configuration defined (no resources actually provisioned)
```
terraform plan -var-file=./input.tfvars
```
To execute and start building the configuration defined in the plan (provisions resources)
```
terraform apply -var-file=./input.tfvars
```
To destroy the VPC and all related resources
```
terraform destroy -var-file=./input.tfvars
```
## Note
All optional parameters, by default, will be set to `null` in respective example's varaible.tf file. You can also override these optional parameters.
# Usage
To create an infrastructure run the following command
``` terraform apply -var-file="input.tfvars"```
Similarly to remove an infrastructure run the following command
```terraform destroy -var-file="input.tfvars"```
## Detect Secret hook
Used to detect secrets within a code base.
To create a secret baseline file run following command
```detect-secrets scan --update .secrets.baseline```
While running the pre-commit hook, if you encounter an error like
```
WARNING: You are running an outdated version of detect-secrets.
Your version: 0.13.1+ibm.27.dss
Latest version: 0.13.1+ibm.46.dss
See upgrade guide at https://ibm.biz/detect-secrets-how-to-upgrade
```
run below command
```pre-commit autoupdate```
which upgrades all the pre-commit hooks present in .pre-commit.yaml file.