diff --git a/docs/install-traffic-capture-sensors/ebpf-sensor/sensor-apt-package.md b/docs/install-traffic-capture-sensors/ebpf-sensor/sensor-apt-package.md index 3208ea2ec..74925d4dc 100644 --- a/docs/install-traffic-capture-sensors/ebpf-sensor/sensor-apt-package.md +++ b/docs/install-traffic-capture-sensors/ebpf-sensor/sensor-apt-package.md @@ -34,7 +34,7 @@ sudo apt update ### 3. Download/install Sensor artifacts ```bash -sudo apt install levo-ebpf-sensor=0.43.6 +sudo apt install levo-ebpf-sensor=0.45.4 ``` ### 4. Start the Sensor @@ -44,38 +44,26 @@ Please take a look at the [Running the Sensor as a Systemd Service](/install-tra ## Sensor Lifecycle Management -### Configure Satellite Address (`host:port` information) +### Configure Satellite Address, Organization-Id and Environment -The Satellite address is configured in `/etc/levo/sensor/config.yaml`. The default `host:port` for Satellite is `localhost:4317`. +The Satellite address is configured in `/etc/default/levo-ebpf-sensor`. The default Satellite URL is `https://collector.levo.ai`. -Edit `/etc/levo/sensor/config.yaml`, set `satellite-url` (under Satellite Settings) to the desired `host:port` value, -and set `organization-id` to the Organization ID fetched from the Levo Dashboard +Edit `/etc/default/levo-ebpf-sensor`, set the `LEVO_SATELLITE_URL` variable to the desired `host:port` value, +and set the `LEVO_ORG_ID` to the Organization ID fetched from the Levo Dashboard. +Set `LEVO_ENV` to the desired environment name in which you wish to see you applications on the Levo Dashboard. ```bash ... -organization-id: "your Org ID" -# -------------------------------------------------------------------------------------------- -# Satellite Settings: -# -------------------------------------------------------------------------------------------- -# host:port for the collector service receiving the sensor's API traces. -# mention the scheme http/https if you decide not to use gRPC for sensor satellite communication -satellite-url: -# -------------------------------------------------------------------------------------------- +LEVO_ENV="your-env" +LEVO_SATELLITE_URL="your-satellite-url" +LEVO_ORG_ID="your-org-id" ... ``` -### Configure sensor environment -The eBPF sensor environment is configured in `/etc/default/levo-ebpf-sensor`. The default env value is `staging` +Additional sensor configs are present in the file `/etc/levo/sensor/config.yaml` -Edit `/etc/default/levo-ebpf-sensor`, and set `LEVO_ENV` to the desired env value (eg. `prod`, `qa`) -```bash -# Environment Variables for levo-ebpf-sensor.service -MALLOC_CONF="background_thread:true,narenas:1,tcache:false,dirty_decay_ms:0,muzzy_decay_ms:0,abort_conf:true" -LEVO_ENV="staging" -``` - -**A Sensor *restart* is required for this to take effect.** +**A Sensor *restart* is required for the config changes to effect.** ### Start Sensor @@ -107,6 +95,11 @@ sudo cat syslog | grep 'levo-ebpf-sensor' cat /etc/levo/sensor/config.yaml ``` +### Show Sensor Environment file +```bash +cat /etc/default/levo-ebpf-sensor +``` + ### Uninstall Sensor ```bash sudo apt remove --purge levo-ebpf-sensor diff --git a/docs/install-traffic-capture-sensors/ebpf-sensor/sensor-docker.md b/docs/install-traffic-capture-sensors/ebpf-sensor/sensor-docker.md index 655c18a56..a82962003 100644 --- a/docs/install-traffic-capture-sensors/ebpf-sensor/sensor-docker.md +++ b/docs/install-traffic-capture-sensors/ebpf-sensor/sensor-docker.md @@ -23,7 +23,7 @@ title: Install eBPF Sensor on Docker | Levo.ai Documentation sudo docker run --restart unless-stopped \ -v /sys/kernel/debug:/sys/kernel/debug -v /proc:/host/proc \ --add-host host.docker.internal:host-gateway \ - --privileged --detach levoai/ebpf_sensor:0.40.0 \ + --privileged --detach levoai/ebpf_sensor:0.45.4 \ --host-proc-path /host/proc/ \ --satellite-url \ --organization-id \ diff --git a/docs/install-traffic-capture-sensors/ebpf-sensor/sensor-systemd-service.md b/docs/install-traffic-capture-sensors/ebpf-sensor/sensor-systemd-service.md index 9a85f99b0..26f370b08 100644 --- a/docs/install-traffic-capture-sensors/ebpf-sensor/sensor-systemd-service.md +++ b/docs/install-traffic-capture-sensors/ebpf-sensor/sensor-systemd-service.md @@ -6,64 +6,26 @@ sidebar_position: 6 ## Running the Sensor as a Systemd Service {#running-sensor-systemd} -### 1. Configure Satellite Address -The Satellite (collector) address is configured in `/etc/levo/sensor/config.yaml`. +### Configure Satellite Address, Organization-Id and Environment -#### NOTE: -The default address for the collector in Systemd installations is `https://collector.levo.ai`. -This address assumes that Levo is hosting the Satellite for you, and you must also specify an organization ID (`organization-id`) via the config file. -If you wish, you may also host the Satellite yourself and specify the address of the collector in the self-hosted Satellite to direct the Sensor's traffic to it. +The Satellite address is configured in `/etc/default/levo-ebpf-sensor`. The default Satellite URL is `https://collector.levo.ai`. +Edit `/etc/default/levo-ebpf-sensor`, set the `LEVO_SATELLITE_URL` variable to the desired `host:port` value, +and set the `LEVO_ORG_ID` to the Organization ID fetched from the Levo Dashboard. +Set `LEVO_ENV` to the desired environment name in which you wish to see you applications on the Levo Dashboard. -Edit `/etc/levo/sensor/config.yaml`, set `satellite-url` (under Satellite Settings) to the desired `host:port` value, -and set `organization-id` to the Organization ID fetched from the Levo Dashboard - -```yaml +```bash ... -organization-id: -# -------------------------------------------------------------------------------------------- -# Satellite Settings: -# -------------------------------------------------------------------------------------------- - -# Levo Organization ID. This must be specified when the collector is hosted by Levo. -# organization-id: "" - -# host:port for the collector service receiving the Sensor's API traces. -satellite-url: +LEVO_ENV="your-env" +LEVO_SATELLITE_URL="your-satellite-url" +LEVO_ORG_ID="your-org-id" ... ``` -**Note**: If you change the Satellite address later, you have to restart the Sensor, since it's not a hot property. - -### 2. Configure Application Name -The `Application Name` is configured in `/etc/levo/sensor/config.yaml`. - -Edit `/etc/levo/sensor/config.yaml`, and set `default-service-name` to the `Application Name` chosen earlier. - -```yaml -# -------------------------------------------------------------------------------------------- -# Default Application Name: -# -# Auto discovered API endpoints and their OpenAPI specifications are show in the API Catalog -# grouped under this application name. The application name helps segregate and group API -# endpoints from different environments. -# -------------------------------------------------------------------------------------------- -# -default-service-name: <'Application Name' chosen earlier> -# -------------------------------------------------------------------------------------------- -``` - -### Configure sensor environment -The eBPF sensor environment is configured in `/etc/default/levo-ebpf-sensor`. The default env value is `staging` -Edit `/etc/default/levo-ebpf-sensor`, and set `LEVO_ENV` to the desired env value (eg. `prod`, `qa`) +Additional sensor configs are present in the file `/etc/levo/sensor/config.yaml` -```bash -# Environment Variables for levo-ebpf-sensor.service -MALLOC_CONF="background_thread:true,narenas:1,tcache:false,dirty_decay_ms:0,muzzy_decay_ms:0,abort_conf:true" -LEVO_ENV="staging" -``` -**Note**: If you change the `Application Name` later, you have to restart the Sensor, since it's not a hot property. +**A Sensor *restart* is required for the config changes to effect.** ### 3. Start the Sensor diff --git a/docs/install-traffic-capture-sensors/ebpf-sensor/sensor-yum-package.md b/docs/install-traffic-capture-sensors/ebpf-sensor/sensor-yum-package.md index cfca2ea78..1fe01a878 100644 --- a/docs/install-traffic-capture-sensors/ebpf-sensor/sensor-yum-package.md +++ b/docs/install-traffic-capture-sensors/ebpf-sensor/sensor-yum-package.md @@ -32,7 +32,7 @@ Install the eBPF Sensor from Levo's RPM repository. 1. Install the package in your repository. ```shell - sudo yum install levo-ebpf-sensor-0.43.6 + sudo yum install levo-ebpf-sensor-0.45.4 ``` Enter `y` when prompted.