Skip to content

Commit a24efcb

Browse files
iadjivonburaizu
andauthored
Agent usage - AIX docs (#30670)
* changes to the AIX docs * quick edits * vale edits * Apply suggestions from code review Co-authored-by: Bryce Eadie <[email protected]> * edit from review * edit from review * edits from review * removed the preview and new from the image * removed the first three links that are no longer used. * added the site link * added the site link * Update content/en/agent/basic_agent_usage/aix.md * Update content/en/agent/basic_agent_usage/aix.md Co-authored-by: Bryce Eadie <[email protected]> * Update content/en/agent/basic_agent_usage/aix.md Co-authored-by: Bryce Eadie <[email protected]> --------- Co-authored-by: Bryce Eadie <[email protected]>
1 parent 2f7f699 commit a24efcb

File tree

2 files changed

+58
-80
lines changed

2 files changed

+58
-80
lines changed

content/en/agent/basic_agent_usage/aix.md

Lines changed: 58 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -14,114 +14,86 @@ algolia:
1414
tags: ['uninstall', 'uninstalling']
1515
---
1616

17-
<div class="alert alert-info">
18-
The Datadog UNIX Agent is being developed for specific system architectures, and is not the same as the Windows, Linux, and MacOS Agents.
19-
</div>
17+
## Overview
18+
The [Datadog UNIX Agent][4] brings host-level monitoring to IBM AIX (PowerPC 8+) so you can visualize system metrics, enable additional Datadog products, and troubleshoot services that still run on-prem.
2019

21-
This page outlines the installation and configuration of the Datadog UNIX Agent for AIX.
20+
The UNIX Agent supports Infrastructure Monitoring and Custom Metrics using [DogStatsD][11]. Other products like APM, Live Process Monitoring, Cloud Network Monitoring, and Log Management are not supported on the UNIX Agent. See [Supported Platforms][5] for the complete list of supported AIX versions.
2221

23-
**Note:** The Datadog UNIX Agent supports PowerPC 8 or greater and the following versions of AIX:
24-
25-
* AIX 6.1 TL9 SP6+
26-
* AIX 7.1 TL5 SP3+
27-
* AIX 7.2 TL3 SP0+
28-
* AIX 7.3 TL3 SP0+
22+
This page walks you through installing, operating, and removing the Datadog UNIX Agent on AIX.
2923

3024
## Installation
3125

32-
A one-step ksh install script is provided on the [Agent download page][1] within Datadog. The script supports the following environment variables:
26+
### Prerequisites
27+
- Root privileges (or sudo) on each host
28+
- Outbound HTTPS (443) to `.datadoghq.com`
29+
- curl or ksh (shipped on AIX by default)
30+
- Verify your host is running a [Supported AIX version][5]
3331

34-
* **CHANNEL**: defaults to stable. Specifies the package repository channel.
35-
* Values: `stable`, `beta`, `unstable`
36-
* **VERSION**: defaults to latest. Specifies the package version.
37-
* **PROXY**: defaults to none. Specifies the proxy URI.
38-
* Example: `http://proxy.foo.com`
39-
* **PROXY_USER**: defaults to empty. Specifies the proxy server username.
40-
* **PROXY_PASSWORD**: defaults to empty. Specifies the proxy server password. For the process/container Agent, this variable is required for passing in an authentication password and cannot be renamed.
41-
* **INSECURE**: defaults to `false`. Allows skipping TLS validation.
32+
### Install the Agent
4233

43-
Alternatively, download links for the latest releases can be found on [this page][2].
34+
To install the Agent on AIX, follow the [in-app instructions in Fleet Automation][6], and run the generated script on your hosts.
4435

45-
The installer may be executed as follows (as root):
36+
{{< img src="/agent/basic_agent_usage/aix_img2_july_25.png" alt="The Datadog Agent installation step for AIX hosts." style="width:90%;">}}
4637

47-
{{< code-block lang="shell" wrap="true" >}}
48-
installp -aXYgd ./datadog-unix-agent-<VERSION>.bff -e dd-aix-install.log datadog-unix-agent
49-
{{< /code-block >}}
5038

51-
This installs the Agent in `/opt/datadog-agent`.
5239

5340
### Installation log files
5441

5542
You can find the Agent installation log in the `dd-aix-install.log` file. To disable this logging, remove the `-e dd-aix-install.log` parameter in the installation command.
5643

5744
## Commands
5845

59-
| Description | Command (as root) |
60-
|---------------------------------|-----------------------------|
61-
| Start Agent as a service | `startsrc -s datadog-agent` |
62-
| Stop Agent running as a service | `stopsrc -s datadog-agent` |
63-
| Status of Agent service | `lssrc -s datadog-agent` |
64-
| Status page of running Agent | `datadog-agent status` |
65-
| Send flare | `datadog-agent flare` |
66-
| Display command usage | `datadog-agent --help` |
67-
68-
## Configuration
69-
70-
The configuration files and folders for the Agent are located in `/etc/datadog-agent/datadog.yaml`
71-
72-
A sample configuration file can be found in `/etc/datadog-agent/datadog.yaml.example`.
46+
| Description | Command (as root) |
47+
|---------------|-----------------------------|
48+
| Start Agent | `startsrc -s datadog-agent` |
49+
| Stop Agent | `stopsrc -s datadog-agent` |
50+
| Status of Agent service | `lssrc -s datadog-agent`|
51+
| Agent status page | `datadog-agent status` |
52+
| Send flare | `datadog-agent flare` |
53+
| Show all commands | `datadog-agent --help` |
7354

74-
A basic configuration typically requires your Datadog API key. To submit your metrics to a different site (for example, the EU instance), the `site` configuration option is available.
7555

76-
Occasionally a proxy configuration must be specified depending on your network setup.
56+
## Configure the Agent
7757

78-
**Configuration files for Integrations:**
79-
`/etc/datadog-agent/conf.d/`
58+
The [Datadog Agent configuration file][7] is located in `/etc/datadog-agent/datadog.yaml`. This YAML file holds the host-wide connection details used to send data to Datadog including:
59+
- `api_key`: Your organization's [Datadog API key][8]
60+
- `site`: Target Datadog region (see [Datadog Sites][1])
61+
- `proxy`: HTTP/HTTPS proxy endpoints for outbound traffic (see [Datadog Agent Proxy Configuration][9])
62+
- Default tags, log level, and Datadog configurations
8063

81-
## Integrations
64+
A fully commented reference file, located in `/etc/datadog-agent/datadog.yaml.example`, lists every available option for comparison or to copy and paste.
8265

83-
The UNIX Agent collects system metrics for:
66+
Alternatively, see the [datadog.yaml.example file][10] for all available configuration options.
8467

85-
* cpu
86-
* filesystem
87-
* iostat
88-
* load
89-
* memory
90-
* uptime
91-
* disk
92-
* network
9368

94-
Additionally, the following integrations can be enabled to collect further metrics:
69+
### Integration files
9570

96-
* process
97-
* lparstats
98-
* [ibm_was (Websphere Application Server)][3]
71+
Configuration files for integrations exist in `/etc/datadog-agent/conf.d/`.
72+
Each integration has its own subdirectory, `<INTEGRATION>.d/`, that contains:
73+
- `conf.yaml`: The active configuration controlling how the integration gathers metrics and logs
74+
- `conf.yaml.example`: A sample illustrating supported keys and defaults
9975

100-
Enable the above integrations by copying and editing the sample configuration files provided. These are found in `/etc/datadog-agent/conf.d`. The name of the YAML configuration file should match that of the integration: `/etc/datadog-agent/conf.d/<INTEGRATION_NAME>.d/conf.yaml` enables the integration `<INTEGRATION_NAME>`, and set its configuration. Example configuration files can be found at `/etc/datadog-agent/conf.d/<INTEGRATION_NAME>.d/conf.yaml.example`
10176

102-
**Note**: Some of the available metrics differ between the integrations for the UNIX Agent and the integrations for Linux, Windows and MacOS. Although it is possible to monitor processes and network metrics with the UNIX Agent, the Live Process Monitoring and Cloud Network Monitoring capabilities aren't available. Log Management is also not available with the UNIX Agent.
77+
## Available integrations
10378

104-
<div class="alert alert-info">The UNIX Agent has no trace-agent component, so APM tracing and profiling is not supported.</div>
79+
Out of the box integrations
80+
: `cpu`
81+
: `filesystem`
82+
: `iostat`
83+
: `load`
84+
: `memory`
85+
: `uptime`
86+
: `disk`
87+
: `network`
10588

106-
## Running DogStatsD
89+
Additional integrations
90+
: `process`
91+
: `lparstats`
92+
: `ibm_was` (WebSphere Application Server)
10793

108-
DogStatsD allows collecting and submitting custom metrics to Datadog. It listens on a UDP port and DogStatsD metrics may be submitted to it. These are then relayed to Datadog.
109-
110-
DogStatsD relies on the same configuration file defined for the Agent, where a DogStatsD configuration section is available. The DogStatsD server typically runs within the same Agent process—but should you need a dedicated process, it may also be launched in standalone mode.
111-
112-
To enable DogStatsD, edit `/etc/datadog-agent/datadog.yaml` and set the relevant configuration options.
113-
114-
{{< code-block lang="yaml" filename="/etc/datadog-agent/datadog.yaml" >}}
115-
dogstatsd: # DogStatsD configuration options
116-
enabled: true # disabled by default
117-
bind_host: localhost # address we'll be binding to
118-
port: 8125 # DogStatsD UDP listening port
119-
non_local_traffic: false # listen to non-local traffic
120-
{{< /code-block >}}
12194

122-
**Note:** DogStatsD does not daemonize and runs in the foreground.
95+
**Note:** Metric coverage can differ from the UNIX, Linux, Windows, and macOS integrations.
12396

124-
There are also facilities to run the Agent with the known Python supervisor. This might be your preferred way to manage the Agent daemon if you are familiar with the tool. There are entries for both the Agent and DogStatsD.
12597

12698
## Monitor Agent uptime
12799

@@ -135,12 +107,18 @@ To remove an installed Agent, run the following `installp` command:
135107
installp -e dd-aix-uninstall.log -uv datadog-unix-agent
136108
{{< /code-block >}}
137109

138-
Note: Agent uninstallation logs can be found in the `dd-aix-install.log` file. To disable this logging, remove the `-e` parameter in the uninstallation command.
110+
**Note:** Agent uninstallation logs can be found in the `dd-aix-install.log` file. To disable this logging, remove the `-e` parameter in the uninstallation command.
139111

140112
## Further Reading
141113

142114
{{< partial name="whats-next/whats-next.html" >}}
143115

144-
[1]: https://app.datadoghq.com/account/settings/agent/latest?platform=aix
145-
[2]: https://github.com/DataDog/datadog-unix-agent/releases
146-
[3]: https://github.com/DataDog/datadog-unix-agent/blob/master/checks/bundled/ibm_was/README.md
116+
[1]: /getting_started/site/#access-the-datadog-site
117+
[4]: https://github.com/DataDog/datadog-unix-agent/blob/master/README.md
118+
[5]: /agent/supported_platforms/?tab=unix
119+
[6]: https://app.datadoghq.com/fleet/install-agent/latest?platform=aix
120+
[7]: /agent/configuration/agent-configuration-files/#agent-main-configuration-file
121+
[8]: https://app.datadoghq.com/organization-settings/api-keys
122+
[9]: /agent/configuration/proxy/
123+
[10]: https://github.com/DataDog/datadog-unix-agent/blob/master/docs/datadog.yaml.example
124+
[11]: /developers/dogstatsd/?tab=hostagent
329 KB
Loading

0 commit comments

Comments
 (0)