Portainer Templates logo

Portainer Templates

Sematext Docker Agent (container) Sematext Docker Agent (container)

Log ManagementMonitoring

Collect logs, metrics and docker events

Image details

Pulls: 10.9M
Architecture: amd64, arm
Image size: 89 MB
Latest: 1.31.74
User: sematext
Created: Dec 02, 2015
Updated: 7 years ago
Status: active

Source details

Repo: sematext/sematext-agent-docker
Stars: 208
Forks: 32
Language: JavaScript
License: Apache-2.0
Updated: 2 years ago
Website: sematext.com/docker

Configuration

Type
Container
Platform
linux
Image
sematext/sematext-agent-docker:latest
Privileged
Yes
Volumes
/var/run/docker.sock : /var/run/docker.sock
Env vars
LOGSENE_TOKEN=''SPM_TOKEN=''

Template by portainer

Standalone Install

Select an install method, to see config/commands for deploying Sematext Docker Agent (container)

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Sematext Docker Agent (container), fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation, or see sematext/sematext-agent-docker for app-specific guidance.

This image is deprecated

Please use sematext/agent for monitoring and sematext/logagent for log collection.
Both images are available as Docker certified images:
See the following posts for more details:

Sematext Agent for Docker

|||| |---|------------|------------| | Sematext Docker Certified | build status
Sematext Agent for Docker collects Metrics, Events and Logs from the Docker API for Docker Monitoring & Logging & Hosted Elastic Stack. Works with CoreOS, Rancher, Docker Swarm, Kubernetes, Apache Mesos, Hashicorp Nomad, Amazon ECS, ... see the installation.

Quickstart

  1. Get free Sematext account
    Create a Monitoring App of type "Docker" for Docker metrics. Copy its App Token. 
Optionally, [create a Logs App](https://apps.sematext.com/ui/integrations)
  1. Run the image using individual App tokens for your Monitoring and Logs Apps
```
docker pull sematext/sematext-agent-docker
docker run -d --name sematext-agent-docker -e SPM_TOKEN=YOUR_SPM_TOKEN -e LOGSENE_TOKEN=YOUR_LOGSENE_TOKEN -v /var/run/docker.sock:/var/run/docker.sock sematext/sematext-agent-docker
```

 You’ll see your Docker metrics in [Sematext Cloud](https://sematext.com/cloud) after about a minute.
  1. Watch metrics, search container logs, use anomaly detection for logs and metrics, create email reports and much more ...

Certified and Public images

There are several places to obtain Sematext Docker Agent images:
  1. Docker Certified images in Docker Store 

docker pull store/sematext/sematext-agent-docker
``` 

2. Red Hat certified images in [Red Hat Container Catalog](https://access.redhat.com/containers/?tab=overview&platform=docker#/registry.connect.redhat.com/sematext/sematext-agent-docker)
docker login registry.connect.redhat.com docker pull registry.connect.redhat.com/sematext/sematext-agent-docker 
3. Public images from [Docker Hub](https://hub.docker.com/r/sematext/sematext-agent-docker/)
docker pull docker.io/sematext/sematext-agent-docker ```

Support

  1. Sematext Docker Agent Homepage
  2. Sematext Docker Agent Documentation
  3. Chat with us via Sematext Cloud UI or drop an e-mail to support@sematext.com

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs sematext-agent
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Can't reach the Docker socket

sematext-agent talks to Docker through /var/run/docker.sock. If the logs show "permission denied while trying to connect to the Docker daemon socket", the app's user can't access it.

  • Check the socket exists on the host: ls -l /var/run/docker.sock
  • Run the container as root, or add the docker group's id to the container with group_add.

Image won't pull

Test the pull directly on the host: docker pull sematext/sematext-agent-docker:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Required settings are blank

LOGSENE_TOKEN, SPM_TOKEN have no default value, and sematext-agent may crash or misbehave if left empty.

  • Fill them in on the deploy screen before hitting deploy.

Privileged mode

This template runs the container in privileged mode, giving it full access to your host.

  • Only deploy it if you trust the app.
  • If deployment is blocked, your Portainer security settings or hardened host may not allow privileged containers.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Sematext Docker Agent (container) runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Sematext Docker Agent (container) needs bundled into one download. This template pulls sematext/sematext-agent-docker:latest, which Docker fetches once (about 89 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Sematext Docker Agent (container)'s comes from Docker Hub, published by sematext.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 1.31.74. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Volumes

A volume is where Sematext Docker Agent (container) keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /var/run/docker.sock from /var/run/docker.sock on the host (a socket it talks to, not storage)

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Sematext Docker Agent (container) takes 2 of them, and 2 need a value before it'll start properly:

  • LOGSENE_TOKEN, needs a value. Logs token
  • SPM_TOKEN, needs a value. SPM monitoring token

Networking

Nothing custom is set, so Sematext Docker Agent (container) sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container sematext-agent. That's what you'll spot in the containers list and use in commands like docker logs sematext-agent.

Privileged mode

This template runs Sematext Docker Agent (container) in privileged mode, which gives it nearly as much access to your server as the system itself. Some apps genuinely need it to reach hardware or manage the host, so it's one to run only if you trust the source.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

Sematext Docker Agent (container) is open source, released under the Apache-2.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Sematext Docker Agent (container) up. Add the template list to Portainer once, then deploying Sematext Docker Agent (container) is a click rather than a wall of config.