Skip to content

Commit

Permalink
Publish AST v0.3.2
Browse files Browse the repository at this point in the history
  • Loading branch information
Application Study Tool Builder committed Aug 29, 2024
1 parent ba40a8c commit c2c252e
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@
## Overview

The Application Study Tool is intended to provide enhanced insights into (classic) BIG-IP products, leveraging best in class
open source telemetry tools. The full installation inculdes:
open source telemetry tools. The full installation includes:

* Custom Instance of OpenTelemetry Collector with enhanced BIG-IP data receivers (data fetched via iControlRest).
* Prometheus timeseries database for storing and querying collected data.
* Grafana Instance with pre-configured dashboards for quick insights at the device and "fleet" levels.

The Application Study Tool has everything needed to quickly get up and running with application insights at less than
production levels of reliability. For production/operational use cases, you can build on the included components,
accounting for things like high availability, enhanced security via e.g. grafana OIDC integrationm, and similar. Alternatively,
the openetlemetry collector can be configured to send data to existing production ops monitoring tools as desired.
accounting for things like high availability, enhanced security via e.g. Grafana OIDC integration, and similar. Alternatively,
the Openetlemetry Collector can be configured to send data to existing production ops monitoring tools as desired.

## Getting Started

Expand Down Expand Up @@ -143,14 +143,14 @@ big-ips.json:
]
```

The configuration paramteter `tls_insecure_skip_verify` defaults to false. Installers
The configuration parameter `tls_insecure_skip_verify` defaults to false. Installers
that would like to opt-in to run in an insecure TLS mode must set
`tls_insecure_skip_verify: true` for each BIG-IP in the config array and understand
that the connection between the OTEL collector and the BIG-IP does not have secure
TLS termination.

### Configure Grafana
The Grafana instance can be configured via environment variable using their standard
The Grafana instance can be configured via environment variables using their standard
[options](https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/#override-configuration-with-environment-variables).

The included .env-example can be copied over and modified to set the initial admin
Expand All @@ -169,7 +169,7 @@ docker compose up
```

#### View The Dashboards
The default grafana user/pass is `admin/admin`, and can be accessed at
The default Grafana user/pass is `admin/admin`, and can be accessed at
`http://<hostname>:3000`.


Expand Down

0 comments on commit c2c252e

Please sign in to comment.