- Create an API & API Key on the FireTail Platform
- API: https://www.firetail.ai/docs/create-an-api
- API Token: https://www.firetail.ai/docs/create-an-api-token
git clone https://github.com/FireTail-io/firetail-kubernetes-sensor.git- deploy helm chart
cd helm && helm install firetail-sensor firetail-sensor/ --set apiKey="PS-02-XXXXXXXX"
| Variable Name | Required? | Example | Description |
|---|---|---|---|
FIRETAIL_API_TOKEN |
✅ | PS-02-XXXXXXXX |
The API token the sensor will use to report logs to FireTail |
BPF_EXPRESSION |
❌ | tcp and (port 80 or port 443) |
The BPF filter used by the sensor. See docs for syntax info: https://www.tcpdump.org/manpages/pcap-filter.7.html |
MAX_CONTENT_LENGTH |
❌ | 1048576 |
The sensor will only read requests or responses if their length is less than MAX_CONTENT_LENGTH bytes. |
ENABLE_ONLY_LOG_JSON |
❌ | true |
Enables only logging requests where the content-type implies the payload should be JSON, or the payload is valid JSON regardless of the content-type. |
DISABLE_SERVICE_IP_FILTERING |
❌ | true |
Disables polling Kubernetes for the IP addresses of services & subsequently ignoring all requests captured that aren't made to one of those IPs. |
FIRETAIL_API_URL |
❌ | https://api.logging.eu-west-1.prod.firetail.app/logs/bulk |
The API url the sensor will send logs to. Defaults to the EU region production environment. |
FIRETAIL_KUBERNETES_SENSOR_DEV_MODE |
❌ | true |
Enables debug logging when set to true, and reduces the max age of a log in a batch to be sent to FireTail. |
FIRETAIL_KUBERNETES_SENSOR_DEV_SERVER_ENABLED |
❌ | true |
Enables a demo web server when set to true; useful for sending test requests to. |
Clone the repo, make a .env file with your API token in it, then use the dev target in the provided makefile:
git clone [email protected]:FireTail-io/firetail-kubernetes-sensor.git
cd firetail-kubernetes-sensor
echo FIRETAIL_API_TOKEN=YOUR_API_TOKEN > .env
make devIn another terminal:
curl localhost:8080/worldYou should receive the following response:
Hello, world!
After a few seconds, you should see logs appear in the FireTail SaaS platform.
Publishing to GHCR is done via GitHub actions found in ./.github/workflows.
You can find the images published here: github.com/firetail-io/firetail-kubernetes-sensor/pkgs/container/kubernetes-sensor