Skip to content

Configuration

Configuring Collectors

Configuration parameters for the collectors are passed as environment variables during the installation process, or through a configuration script.

Collection Modes

Collectors can install in one of the following modes:

Collection with local stream processing

This is the default mode. In this mode, network packets and metrics are locally processed at the collector, and only rolled-up time series metrics are shipped over the network to the AOC. The advantage of this mode is lower network bandwidth, but at the cost of higher CPU overhead. Use this mode when limited network bandwidth is available towards the AOC. In addition, this mode only requires an http(s) based interface between the collectors and AOC. The CPU overheads in this mode may be configured via OS' scheduling priority, see EPOCH_NICE_VALUE under configuration

To enable this mode set the EPOCH_ROLE variable as sp_collector

Collection only

In this mode, the collector ships metrics and network packets to the AOC for remote stream processing. This mode has lower CPU overhead at the cost of higher network bandwidth (within the VPC if stream processor is in the same VPC), so it should be used when surplus bandwidth is available from the collector to AOC.

To enable this mode set the EPOCH_ROLE variable as collector

Traffic collection mechanisms Traffic Collection Modes

Note: You may run the collectors in Collection only mode and deploy stream processors on local instances within the same VPC. This approach has the best of both modes in terms of minimum CPU overhead and minimum outgoing bandwidth from the VPC. Refer to the standalone stream processor section for details.

Configuration Parameters

Infrastructure Tags

You can assign Infrastructure Tags during the collector installation process by passing the EPOCH_TAGS environment variable:

EPOCH_TAGS = "tag1,tag_key2:tag_value2"

You may specify tags as comma-separated singletons, key-value pairs, or both.

Please read more about configuring automatic infrastructure tag collection here.

General Configuration

Listed below are some common configuration parameters for the collectors.

Parameter Required Default Choices Description
EPOCH_ORGANIZATION_ID yes n/a string An identifying string for users of the AOC
EPOCH_AOC_HOST yes n/a IP or DNS address The address of your Epoch AOC instance
EPOCH_AOC_PORT no 443 Port number Override the port of AOC where the metrics are sent.
EPOCH_AOC_PROTOCOL no https http or https Override the protocol used to send metrics to AOC
EPOCH_ROLE no sp_collector collector, sp_collector, sp or infra_only Run only collector, collector and stream processor, just stream processor, infrastructure collector only
EPOCH_TAGS no Not defined n/a Comma separated list of tags. Provided as single values or key/value pairs.
EPOCH_AUTOUPGRADE_COLLECTORS no yes yes or no Whether or not to autoupgrade the collectors upon new collector releases
RUN_PRESTART_SCRIPT no no yes or no The user may provide a custom script at /usr/bin/prestart-epoch-collectors.sh, which will be run during configuration if this variable is set to yes.
EPOCH_NICE_VALUE no 15 -20 to 19 Apply unix nice on the stream processor processes, higher value for lower priority
EPOCH_PROXY_HOST no Not defined n/a The hostname of external proxy
EPOCH_PROXY_PORT no Not defined n/a The port of external proxy
EPOCH_PROXY_USER no Not defined n/a The user name for external proxy in case of required authentication
EPOCH_PROXY_PWD no Not defined n/a The password for external proxy in case of required authentication
EPOCH_STATSD_PORT no 8125 Port number You may have to change this port if you have a statsd daemon running on the same machine as the collectors
EPOCH_DD_AGENT_LISTEN_PORT no 17130 Port number You may have to change this port if you have another dd-agent running on the same machine as the collectors
EPOCH_NETWORK_NAMESPACE no epoch string This parameter helps Epoch's discovery backend distinguish between distinct entities having the same IP address for e.g. across overlapping IP address spaces of two distinct VPC's. It is a comma-separated list of key value pairs (no spaces allowed) e.g. "vlan_id:4,vpc_id:my-vpc" -- More to less granular keys from left to right
EPOCH_PKG_REPO_HOST no repo.epoch.nutanix.com IP or DNS address The address of your Epoch collector package repository
EPOCH_PKG_REPO_PORT no 443 Port number The port of your Epoch collector package repository

Remote Packet Capture Configuration

Listed below are the remote packet capture configuration parameters, which tune the traffic-capture capabilities of the collector.

Parameter Required Default Choices Description
EPOCH_ANALYSIS_DEPTH yes layer4 layer4 or layer7 Whether collector will parse packets upto layer4 (Transport layer) or layer7 (application layer). If this parameter is set to layer4 then only metrices available till transport layer will be available. If layer7 is set then both transport layer and application layer protocol stats will be available.
EPOCH_L7_SAMPLINGRATE no 100 Integer <0 - 100> Percentage-based sampling rate -- the percentage of network flows (tcp transactions) to select for protocol parsing (layer7). 0 implies none of the flows are selected and 100 implies that all the flows are selected. We recommend 10% sampling in production and 100% in dev/test environments.
EPOCH_SP_HOST_OVERRIDE no n/a IP or DNS address Override the address of Stream Processor where the captured traffic is sent
EPOCH_SP_PORT_OVERRIDE no n/a Port number Override the Stream Processor port where the captured traffic is sent
EPOCH_SP_LISTEN_PORT no 2005 Port number You may have to change this if tcp/udp port 2005 and tcp port 3005 are not available on the host. The collector listens on tcp and udp port EPOCH_SP_LISTEN_PORT and tcp port EPOCH_SP_LISTEN_PORT + 1000
EPOCH_BPFFILTER no n/a String Sets BPF filter. For custom filters, you may look at the BPF documentation
EPOCH_ENABLE_SSLSPLIT no yes yes or no Enables ssl capture
EPOCH_INTERFACE no any String Sets the network interface on which to capture traffic
EPOCH_TCPMODE no YES YES or NO Enables TCP data channel
EPOCH_MTUSIZE no 1432 Integer Applies only if EPOCH_TCPMODE is YES. This sets the MTU size. This should be less than or equal to the MTU size supported by the network minus 28.

Integrations

Epoch has a variety of integrations that bolster the monitoring capabilities of the AOC. Please check them out on the sidebar menu.