1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
# Agents
## Intro
The Monitoring Agent resides on the host server being monitored. The agent allows you to gather on-host metrics based on agent checks and push them to Cloud Monitoring where you can analyze them, use them with the Cloud Monitoring infrastructure (such as alarms), and archive them.
For more information about this feature, including a brief overview of its core design principles and security layers, see the [official API documentation](http://docs.rackspace.com/cm/api/v1.0/cm-devguide/content/service-agent.html).
## Setup
```php
$agentId = '00-agent.example.com';
$agent = $service->getAgent($agentId);
```
You can view the [service page](Service.md) for more information about setting up the Cloud Monitoring service.
## List agents
```php
$agents = $service->getAgents();
foreach ($agents as $agent) {
echo $agent->getLastConnected();
}
```
Please consult the [iterator doc](docs/userguide/Iterators.md) for more information about iterators.
## List connections
```php
$connections = $agent->getConnections();
```
Please consult the [iterator doc](docs/userguide/Iterators.md) for more information about iterators.
## Get connection
```php
/** @var \OpenCloud\CloudMonitoring\Resource\AgentConnection */
$connection = $agent->getConnection('cntl4qsIbA');
```
### Agent Connection properties
Name|Description|Type|Method
----|-----------|----|------
id|-|-|`getId()`
guid|-|-|`getGuid()`
agent_id|-|-|`getAgentId()`
endpoint|-|-|`getEndpoint()`
process_version|-|-|`getProcessVersion()`
bundle_version|-|-|`getBundleVersion()`
agent_ip|-|-|`getAgentIp()`
# Agent tokens
## Intro
Agent tokens are used to authenticate Monitoring agents to the Monitoring Service. Multiple agents can share a single token.
## Setup
```php
$tokenId = '4c5e28f0-0b3f-11e1-860d-c55c4705a286:1234';
$agentToken = $service->getAgentToken($tokenId);
```
## Create agent token
```php
$newToken = $service->getAgentToken();
$newToken->create(array('label' => 'Foobar'));
```
## List agent tokens
```php
$agentTokens = $service->getAgentTokens();
foreach ($agentTokens as $token) {
echo $token->getLabel();
}
```
Please consult the [iterator doc](docs/userguide/Iterators.md) for more information about iterators.
## Update and delete Agent Token
```php
// Update
$token->update(array(
'label' => 'New label'
));
// Delete
$token->delete();
```
# Agent Host Information
## Info
An agent can gather host information, such as process lists, network configuration, and memory usage, on demand. You can use the host-information API requests to gather this information for use in dashboards or other utilities.
## Setup
```php
$host = $monitoringService->getAgentHost();
```
## Get some metrics
```php
$cpuInfo = $host->info('cpus');
$diskInfo = $host->info('disks');
$filesystemInfo = $host->info('filesystems');
$memoryInfo = $host->info('memory');
$networkIntInfo = $host->info('network_interfaces');
$processesInfo = $host->info('processes');
$systemInfo = $host->info('system');
$userInfo = $host->info('who');
// What CPU models do we have?
foreach ($cpuInfo as $cpuMetric) {
echo $cpuMetric->model, PHP_EOL;
}
// How many disks do we have?
echo $diskInfo->count();
// What's the available space on our ext4 filesystem?
foreach ($filesystemInfo as $filesystemMetric) {
if ($filesystemMetric->sys_type_name == 'ext4') {
echo $filesystemMetric->avail;
}
}
```
# Agent targets
## Info
Each agent check type gathers data for a related set of target devices on the server where the agent is installed. For example, `agent.network` gathers data for network devices. The actual list of target devices is specific to the configuration of the host server. By focusing on specific targets, you can efficiently narrow the metric data that the agent gathers.
### List agent targets
```php
$targets = $service->getAgentTargets();
foreach ($targets as $target) {
echo $target->getType();
}
```
|
