The test-tcell Developer Hub

Welcome to the test-tcell developer hub. You'll find comprehensive guides and documentation to help you start working with test-tcell as quickly as possible, as well as support if you get stuck. Let's jump right in!

Envoy

Installing the Envoy agent

Prerequisites

  • A tCell account
  • Created a tCell application (Admin > Applications)
  • Allowed output HTTPS connections to the tCell cloud: What IPs do tCell agents connect to?
  • Downloaded the config file:
    1. Click on tCell Admin in top nav bar
    2. Click Download Agent
    3. Click on Web Server Agent
    4. Select Envoy agent
    5. Select Create New API Key (default)
    6. Click Download Config File to download the agent's config file (which is pre-populated with the application and API key information)
  • Docker installed.

Some tCell features are not available

OS Commands, Local FiIes, Packages & Vulns. features are not available with Envoy.

Installation

  1. The agent comes built-in to the Envoy binary. To download the agent, run:
docker pull rapid7/envoy-tcell:beta
  1. Update your envoy_config.yaml to include the tcell http filter. The docker image is configured to look for your config file at /etc/envoy/envoy_config.yaml. It will look similar to this:
http_filters:
- name: tcell
- name: envoy.filters.http.router
  1. Run the following (make sure to input your APPID and APIKEY):
docker run -d -p 8090:80 -e "TCELL_AGENT_APP_ID=APIID" -e "TCELL_AGENT_API_KEY=APIKEY" -v /host/path/envoy_config.yaml:/etc/envoy/envoy_config.yaml:ro -t rapid7/envoy-tcell

Verification

To verify that data is being sent to tCell go to your tCell console and confirm that the number of app server agents listed for the application you just created is more than 0.

Troubleshooting

In the Docker image, tCell logs to stdout. Find all errors by running docker logs.

Log level can be customized in tcell_agent.config file by adding a block, such as the following to the application section of the json:

"logging_options": {
    "enabled": true,
    "level": "INFO"
}

See tcell_agent.config.template for an example.

Valid log levels are:

ERROR
WARN
INFO (default)
DEBUG
TRACE

The preceding list indicates the precedence among the levels, from top to bottom. When you enable a log level, the higher log levels are also enabled. For example, if you enable WARN, then ERROR is also enabled.

When a log file becomes full, logging continues in a new log file. See Log Rolling for more information.

Updated 10 days ago


Envoy


Installing the Envoy agent

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.