Back to Charts

Sematext Agent

stable/sematext-agent/README.md

latest6.0 KB
Original Source

This Helm chart is deprecated

Given the deprecation of stable, future Sematext Agent charts will be located at sematext/helm-charts.

To update an existing stable deployment with the chart hosted in the Sematext Agent repository, you should run:

bash
$ helm repo add sematext https://cdn.sematext.com/helm-charts/
$ helm upgrade st-agent sematext/sematext-agent

Sematext Agent

Sematext Agent collects logs, metrics, events and more info for hosts (CPU, memory, disk, network, processes, ...), containers and orchestrator platforms and ships that to Sematext Cloud. Sematext Cloud is available in the US and EU regions.

Introduction

This chart installs the Sematext Agent to all nodes in your cluster via a DaemonSet resource.

Prerequisites

Installation

To install the chart to ship logs run the following command:

bash
$ helm install st-logagent  \
    --set logsToken=YOUR_LOGS_TOKEN \
    --set region=US \
    stable/sematext-agent

To install the chart for monitoring run the following command:

bash
$ helm install st-agent \
    --set containerToken=YOUR_CONTAINER_TOKEN \
    --set infraToken=YOUR_INFRA_TOKEN \
    --set region=US \
    stable/sematext-agent

To install the chart for both logs and monitoring run the following command:

bash
$ helm install st-agent \
    --set logsToken=YOUR_LOGS_TOKEN \
    --set containerToken=YOUR_CONTAINER_TOKEN \
    --set infraToken=YOUR_INFRA_TOKEN \
    --set region=US \
    stable/sematext-agent

After a few minutes, you should see logs, metrics, and events reported in Sematext web UI.

NOTE: If you want to use Sematext hosted in the EU region set the region parameter to --set region=EU. Also, it is worth mentioning that the agent is running as a privileged container.

Removal

To uninstall the chart use:

bash
$ helm uninstall st-logagent

or

bash
$ helm uninstall st-agent

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

The following table lists the configuration parameters of the sematext-agent chart and default values.

ParameterDescriptionDefault
containerTokenSematext Container tokenNil Provide your Container token
logsTokenSematext Logs tokenNil Provide your Logs token
infraTokenSematext Infra tokenNil Provide your Infra token
regionSematext regionUS Sematext US or EU region
agent.image.repositoryThe image repositorysematext/agent
agent.image.tagThe image taglatest
agent.image.pullPolicyImage pull policyAlways
agent.service.portService port80
agent.service.typeService typeClusterIP
agent.resourcesAgent resources{}
logagent.image.repositoryThe image repositorysematext/logagent
logagent.image.tagThe image taglatest
logagent.image.pullPolicyImage pull policyAlways
logagent.resourcesLogagent resources{}
logagent.customConfigsLogagent custom configs[] Check values.yaml
logagent.extraHostVolumeMountsExtra mounts{}
serviceAccount.createCreate a service accounttrue
serviceAccount.nameService account nameNil Defaults to chart name
priorityClassNamePriority class nameNil
rbac.createRBAC enabledtrue
tolerationsTolerations[]
nodeSelectorNode selector{}
serverBaseUrlCustom Base URLNil
logsReceiverUrlCustom Logs receiver URLNil
eventsReceiverUrlCustom Event receiver URLNil

Specify each parameter using the --set key=value argument to helm install. For example:

bash
$ helm install st-agent \
    --set containerToken=YOUR_CONTAINER_TOKEN \
    --set infraToken=YOUR_INFRA_TOKEN \
    --set region=US \
    --set agent.image.tag=0.18.3 \
    --set agent.image.pullPolicy=IfNotPresent \
    stable/sematext-agent

Alternatively, you can use a YAML file that specifies the values while installing the chart. For example:

bash
$ helm install st-agent -f custom_values.yaml stable/sematext-agent