# topbeat

**Repository Path**: mirrors_urso/topbeat

## Basic Information

- **Project Name**: topbeat
- **Description**: Ship system wide and per process statistics to Elasticsearch
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-11-23
- **Last Updated**: 2026-03-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Jenkins Build Status](http://build-eu-00.elastic.co/job/topbeat/badge/icon)](http://build-eu-00.elastic.co/job/topbeat/)
[![Travis Status](https://travis-ci.org/elastic/topbeat.svg?branch=master)](https://travis-ci.org/elastic/topbeat)
[![Appveyor status](https://ci.appveyor.com/api/projects/status/k4jnsyt27dcw6s3v?svg=true)](https://ci.appveyor.com/project/elastic-beats/topbeat)

[![codecov.io](http://codecov.io/github/elastic/topbeat/coverage.svg?branch=master)](http://codecov.io/github/elastic/topbeat?branch=master)

# Topbeat

Topbeat is the [Beat](https://www.elastic.co/products/beats) used for
server monitoring. It is a lightweight agent that installed on your servers,
reads periodically system wide and per process CPU and memory statistics and indexes them in
Elasticsearch.

## Documentation

You can find the documentation on the [elastic.co](https://www.elastic.co/guide/en/beats/topbeat/current/index.html) website.

## Exported fields

There are three types of documents exported:
- `type: system` for system wide statistics
- `type: proc` for per process statistics. One per process.
- `type: filesystem` for disk usage statistics. One per mount point.

System statistics:

<pre>
{
  "@timestamp": "2015-11-10T13:59:48.178Z",
  "beat": {
    "hostname": "MacBook-Pro.local",
    "name": "MacBook-Pro.local",
    "version": "1.0.0-rc1"
  },
  "count": 1,
  "cpu": {
    "user": 2985331,
    "user_p": 0,
    "nice": 0,
    "system": 1727403,
    "system_p": 0,
    "idle": 25915908,
    "iowait": 0,
    "irq": 0,
    "softirq": 0,
    "steal": 0
  },
  "load": {
    "load1": 1.52392578125,
    "load5": 1.79736328125,
    "load15": 1.98291015625
  },
  "mem": {
    "total": 17179869184,
    "used": 8868311040,
    "free": 8311558144,
    "used_p": 0.52,
    "actual_used": 8355057664,
    "actual_free": 8824811520,
    "actual_used_p": 0.49
  },
  "swap": {
    "total": 2147483648,
    "used": 736624640,
    "free": 1410859008,
    "used_p": 0.34,
    "actual_used": 0,
    "actual_free": 0,
    "actual_used_p": 0
  },
  "type": "system"
}
</pre>

Per process statistics:

<pre>
{
  "@timestamp": "2015-11-10T13:59:48.178Z",
  "beat": {
    "hostname": "MacBook-Pro.local",
    "name": "MacBook-Pro.local",
    "version": "1.0.0-rc1"
  },
  "count": 1,
  "proc": {
    "cpu": {
      "user": 1,
      "user_p": 0,
      "system": 1,
      "total": 2,
      "start_time": "15:59"
    },
    "mem": {
      "size": 2491260928,
      "rss": 774144,
      "rss_p": 0,
      "share": 0
    },
    "name": "less",
    "pid": 20366,
    "ppid": 10392,
    "state": "running"
  },
  "type": "proc"
}
</pre>

Per file system statistics:

<pre>
{
  "@timestamp": "2015-11-10T14:02:02.345Z",
  "beat": {
    "hostname": "MacBook-Pro.local",
    "name": "MacBook-Pro.local",
    "version": "1.0.0-rc1"
  },
  "count": 1,
  "fs": {
    "device_name": "devfs",
    "total": 198656,
    "used": 198656,
    "used_p": 1,
    "free": 0,
    "avail": 0,
    "files": 677,
    "free_files": 0,
    "mount_point": "/dev"
  },
  "type": "filesystem"
}
</pre>

## Elasticsearch template

To apply topbeat template:

    curl -XPUT 'http://localhost:9200/_template/topbeat' -d@etc/topbeat.template.json