Skip to content

Commit

Permalink
Publish AST v0.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Application Study Tool Builder committed Sep 23, 2024
1 parent c2c252e commit 27b3ba6
Show file tree
Hide file tree
Showing 17 changed files with 6,296 additions and 430 deletions.
58 changes: 58 additions & 0 deletions COLLECTOR_README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# F5 Big-IP Receiver

<!-- status autogenerated section -->
| Status | |
| ------------- |-----------|
| Stability | [beta]: metrics |
| Distributions | [contrib] |
| Issues | [![Open issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aopen%20label%3Areceiver%2Fbigip%20&label=open&color=orange&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aopen+is%3Aissue+label%3Areceiver%2Fbigip) [![Closed issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aclosed%20label%3Areceiver%2Fbigip%20&label=closed&color=blue&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aclosed+is%3Aissue+label%3Areceiver%2Fbigip) |
| [Code Owners](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#becoming-a-code-owner) | [@djaglowski](https://www.github.com/djaglowski), [@StefanKurek](https://www.github.com/StefanKurek) \| Seeking more code owners! |

[beta]: https://github.com/open-telemetry/opentelemetry-collector#beta
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->

This receiver fetches stats from a F5 Big-IP node using F5's [iControl REST API](https://clouddocs.f5.com/api/icontrol-rest).

## Prerequisites

This receiver supports Big-IP versions `11.6.5+`

## Configuration

The following settings are required:

- `username`
- `password`

The following settings are optional:

- `endpoint` (default: `https://localhost:443`): The URL of the Big-IP environment.
- `collection_interval` (default = `10s`): This receiver collects metrics on an interval. Valid time units are `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`.
- `tls` (defaults defined [here](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md)): TLS control. By default insecure settings are rejected and certificate verification is on.
- `enable_http_client_metrics` (default = `false`): Enable collection of metrics for http client requests to the device.
- `data_types` (default: all enabled): This map allows you to enable / disable collection and sending of data by type. The list of available data types can be found in `./config.go`, in the DataTypesConfig struct definition.

### Example Configuration

```yaml
receivers:
bigip:
collection_interval: 10s
endpoint: https://localhost:443
username: otelu
password: ${env:BIGIP_PASSWORD}
tls:
insecure_skip_verify: true
enable_http_client_metrics: true
data_types:
f5.profile.web_acceleration:
enabled: false
attribute_name: some_alternative_data_type_name
```
The full list of settings exposed for this receiver are documented [here](./config.go) with detailed sample configurations [here](./testdata/config.yaml). TLS config is documented further under the [opentelemetry collector's configtls package](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md).
## Metrics
Details about the metrics produced by this receiver can be found in [documentation.md](./documentation.md)
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ production levels of reliability. For production/operational use cases, you can
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.

![](./diagrams/ui.gif)

## Getting Started

### Prerequisites
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v0.3.1
v0.4.0
2 changes: 1 addition & 1 deletion docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ services:
command: ["/bin/sh", "/app/init_entrypoint.sh"]

otel-collector:
image: ghcr.io/f5devcentral/application-study-tool/otel_custom_collector:v0.3.1
image: ghcr.io/f5devcentral/application-study-tool/otel_custom_collector:v0.4.0
restart: unless-stopped
volumes:
- otel_collector:/etc/otel-collector-config
Expand Down
Loading

0 comments on commit 27b3ba6

Please sign in to comment.