---
title: FileMage
description: Monitoring Agent for FileMage services
breadcrumbs: Docs > Integrations > FileMage
---

# FileMage
Supported OS Integration version1.0.0Carousel Logo
## Overview{% #overview %}

This check monitors [FileMage](https://www.filemage.io/).

## Setup{% #setup %}

### Installing the package{% #installing-the-package %}

For the Datadog Agent v7.21 or v6.21 and later, follow these instructions to install the Filemage integration on your host.See [Use Community Integrations](https://docs.datadoghq.com/agent/guide/use-community-integrations.md) to install it with the Docker Agent or earlier versions of the Datadog Agent.

1. Run the following command to install the Agent integration:

```shell
datadog-agent integration install -t datadog-filemage==1.0.0
```
Configure your integration similar to an Agent-based [integration](https://docs.datadoghq.com/getting_started/integrations.md).
### Configuration{% #configuration %}

1. Edit the `filemage.d/conf.yaml.example` file in the `conf.d/` folder at the root of your [Agent Configuration Directory](https://docs.datadoghq.com/agent/guide/agent-configuration-files.md#agent-configuration-directory) to start collecting your FileMage metrics.Once complete, save the modified file as `filemage.d/conf.yaml`.See the [sample filemage conf.yaml](https://github.com/DataDog/integrations-extras/blob/master/filemage/datadog_checks/filemage/data/conf.yaml.example) for all available configuration options.

1. [Restart the Agent](https://docs.datadoghq.com/agent/guide/agent-commands.md#start-stop-and-restart-the-agent).

### Validation{% #validation %}

Run the [Agent's `status` subcommand](https://docs.datadoghq.com/agent/guide/agent-commands.md#agent-status-and-information) and look for `filemage` under the Running Checks section.

```text
...

  Running Checks
  ==============

    ...

    filemage (1.0.0)
    ----------------
      Instance ID: filemage:ac55127bf7bd70b9 [OK]
      Configuration Source: file:/etc/datadog-agent/conf.d/filemage.d/conf.yaml
      Total Runs: 1,298
      Metric Samples: Last Run: 0, Total: 0
      Events: Last Run: 0, Total: 0
      Service Checks: Last Run: 2, Total: 2,594
      Average Execution Time : 41ms
      Last Execution Date : 2022-11-23 15:59:22 EST / 2022-11-23 20:59:22 UTC (1669237162000)
      Last Successful Execution Date : 2022-11-23 15:59:22 EST / 2022-11-23 20:59:22 UTC (1669237162000)
```

## Data Collected{% #data-collected %}

This integration tracks the number of times each FTP command is run.

### Metrics{% #metrics %}

|  |
|  |
| **filemage.ftp.account**(count)      | Number of times the account FTP command was received      |
| **filemage.ftp.append**(count)       | Number of times the append FTP command was received       |
| **filemage.ftp.ascii**(count)        | Number of times the ascii FTP command was received        |
| **filemage.ftp.bell**(count)         | Number of times the bell FTP command was received         |
| **filemage.ftp.binary**(count)       | Number of times the binary FTP command was received       |
| **filemage.ftp.bye**(count)          | Number of times the bye FTP command was received          |
| **filemage.ftp.case**(count)         | Number of times the case FTP command was received         |
| **filemage.ftp.cd**(count)           | Number of times the cd FTP command was received           |
| **filemage.ftp.cdup**(count)         | Number of times the cdup FTP command was received         |
| **filemage.ftp.chmod**(count)        | Number of times the chmod FTP command was received        |
| **filemage.ftp.close**(count)        | Number of times the close FTP command was received        |
| **filemage.ftp.cr**(count)           | Number of times the cr FTP command was received           |
| **filemage.ftp.qc**(count)           | Number of times the qc FTP command was received           |
| **filemage.ftp.delete**(count)       | Number of times the delete FTP command was received       |
| **filemage.ftp.debug**(count)        | Number of times the debug FTP command was received        |
| **filemage.ftp.disconnect**(count)   | Number of times the disconnect FTP command was received   |
| **filemage.ftp.form**(count)         | Number of times the form FTP command was received         |
| **filemage.ftp.get**(count)          | Number of times the get FTP command was received          |
| **filemage.ftp.glob**(count)         | Number of times the glob FTP command was received         |
| **filemage.ftp.hash**(count)         | Number of times the hash FTP command was received         |
| **filemage.ftp.help**(count)         | Number of times the help FTP command was received         |
| **filemage.ftp.idle**(count)         | Number of times the idle FTP command was received         |
| **filemage.ftp.ipany**(count)        | Number of times the ipany FTP command was received        |
| **filemage.ftp.ipv4**(count)         | Number of times the ipv4 FTP command was received         |
| **filemage.ftp.ipv6**(count)         | Number of times the ipv6 FTP command was received         |
| **filemage.ftp.lcd**(count)          | Number of times the lcd FTP command was received          |
| **filemage.ftp.macdef**(count)       | Number of times the macdef FTP command was received       |
| **filemage.ftp.mdelete**(count)      | Number of times the mdelete FTP command was received      |
| **filemage.ftp.mdir**(count)         | Number of times the mdir FTP command was received         |
| **filemage.ftp.mget**(count)         | Number of times the mget FTP command was received         |
| **filemage.ftp.mkdir**(count)        | Number of times the mkdir FTP command was received        |
| **filemage.ftp.mls**(count)          | Number of times the mls FTP command was received          |
| **filemage.ftp.mode**(count)         | Number of times the mode FTP command was received         |
| **filemage.ftp.modtime**(count)      | Number of times the modtime FTP command was received      |
| **filemage.ftp.mput**(count)         | Number of times the mput FTP command was received         |
| **filemage.ftp.newer**(count)        | Number of times the newer FTP command was received        |
| **filemage.ftp.nmap**(count)         | Number of times the nmap FTP command was received         |
| **filemage.ftp.ntrans**(count)       | Number of times the ntrans FTP command was received       |
| **filemage.ftp.open**(count)         | Number of times the open FTP command was received         |
| **filemage.ftp.prompt**(count)       | Number of times the prompt FTP command was received       |
| **filemage.ftp.proxy**(count)        | Number of times the proxy FTP command was received        |
| **filemage.ftp.put**(count)          | Number of times the put FTP command was received          |
| **filemage.ftp.pwd**(count)          | Number of times the pwd FTP command was received          |
| **filemage.ftp.quit**(count)         | Number of times the quit FTP command was received         |
| **filemage.ftp.quote**(count)        | Number of times the quote FTP command was received        |
| **filemage.ftp.recv**(count)         | Number of times the recv FTP command was received         |
| **filemage.ftp.reget**(count)        | Number of times the reget FTP command was received        |
| **filemage.ftp.remotehelp**(count)   | Number of times the remotehelp FTP command was received   |
| **filemage.ftp.remotestatus**(count) | Number of times the remotestatus FTP command was received |
| **filemage.ftp.reset**(count)        | Number of times the reset FTP command was received        |
| **filemage.ftp.restart**(count)      | Number of times the restart FTP command was received      |
| **filemage.ftp.rmdir**(count)        | Number of times the rmdir FTP command was received        |
| **filemage.ftp.runique**(count)      | Number of times the runique FTP command was received      |
| **filemage.ftp.send**(count)         | Number of times the send FTP command was received         |
| **filemage.ftp.sendport**(count)     | Number of times the sendport FTP command was received     |
| **filemage.ftp.site**(count)         | Number of times the site FTP command was received         |
| **filemage.ftp.size**(count)         | Number of times the size FTP command was received         |
| **filemage.ftp.status**(count)       | Number of times the status FTP command was received       |
| **filemage.ftp.struct**(count)       | Number of times the struct FTP command was received       |
| **filemage.ftp.sunique**(count)      | Number of times the sunique FTP command was received      |
| **filemage.ftp.system**(count)       | Number of times the system FTP command was received       |
| **filemage.ftp.tenex**(count)        | Number of times the tenex FTP command was received        |
| **filemage.ftp.trace**(count)        | Number of times the trace FTP command was received        |
| **filemage.ftp.type**(count)         | Number of times the type FTP command was received         |
| **filemage.ftp.umask**(count)        | Number of times the umask FTP command was received        |
| **filemage.ftp.verbose**(count)      | Number of times the verbose FTP command was received      |

### Service Checks{% #service-checks %}

**filemage.services\_up**

Returns `CRITICAL` if the services are down, or `OK` if the services are running.

*Statuses: ok, critical*

**filemage.metrics\_up**

Returns `WARNING` if check was unable to retrieve metrics, or `OK` if the metrics were successfully submitted.

*Statuses: ok, warning*

### Events{% #events %}

The FileMage integration does not include any events.

## Troubleshooting{% #troubleshooting %}

Need help? Contact [dOpenSource](https://dopensource.com/).