-
Notifications
You must be signed in to change notification settings - Fork 399
/
docker-info.js
261 lines (231 loc) · 7.59 KB
/
docker-info.js
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
/*
* Copyright 2020 New Relic Corporation. All rights reserved.
* SPDX-License-Identifier: Apache-2.0
*/
'use strict'
const fs = require('node:fs')
const http = require('node:http')
const log = require('../logger').child({ component: 'docker-info' })
const common = require('./common')
const NAMES = require('../metrics/names')
const os = require('os')
let vendorInfo = null
const CGROUPS_V1_PATH = '/proc/self/cgroup'
const CGROUPS_V2_PATH = '/proc/self/mountinfo'
const BOOT_ID_PROC_FILE = '/proc/sys/kernel/random/boot_id'
module.exports.getVendorInfo = fetchDockerVendorInfo
module.exports.clearVendorCache = function clearDockerVendorCache() {
vendorInfo = null
}
module.exports.getBootId = function getBootId(agent, callback, logger = log) {
if (!/linux/i.test(os.platform())) {
logger.debug('Platform is not a flavor of linux, omitting boot info')
return setImmediate(callback, null, null)
}
fs.access(BOOT_ID_PROC_FILE, fs.constants.F_OK, (err) => {
if (err == null) {
// The boot id proc file exists, so use it to get the container id.
return common.readProc(BOOT_ID_PROC_FILE, (_, data, cbAgent = agent) => {
readProcBootId({ data, agent: cbAgent, callback })
})
}
logger.debug('Container boot id is not available in cgroups info')
if (hasAwsContainerApi() === false) {
// We don't seem to have a recognized location for getting the container
// identifier.
logger.debug('Container is not in a recognized ECS container, omitting boot info')
recordBootIdError(agent)
return callback(null, null)
}
getEcsContainerId({ agent, callback, logger })
})
}
/**
* Queries the AWS ECS metadata API to get the boot id.
*
* @param {object} params Function parameters.
* @param {object} params.agent Newrelic agent instance.
* @param {Function} params.callback Typical error first callback. The second
* parameter is the boot id as a string.
* @param {object} [params.logger] Internal logger instance.
*/
function getEcsContainerId({ agent, callback, logger }) {
const ecsApiUrl =
process.env.ECS_CONTAINER_METADATA_URI_V4 || process.env.ECS_CONTAINER_METADATA_URI
const req = http.request(ecsApiUrl, (res) => {
let body = Buffer.alloc(0)
res.on('data', (chunk) => {
body = Buffer.concat([body, chunk])
})
res.on('end', () => {
try {
const json = body.toString('utf8')
const data = JSON.parse(json)
if (data.DockerId == null) {
logger.debug('Failed to find DockerId in response, omitting boot info')
recordBootIdError(agent)
return callback(null, null)
}
callback(null, data.DockerId)
} catch (error) {
logger.debug('Failed to process ECS API response, omitting boot info: ' + error.message)
recordBootIdError(agent)
callback(null, null)
}
})
})
req.on('error', () => {
logger.debug('Failed to query ECS endpoint, omitting boot info')
recordBootIdError(agent)
callback(null, null)
})
req.end()
}
/**
* Inspects the running environment to determine if the AWS ECS metadata API
* is available.
*
* @see https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ec2-metadata.html
*
* @returns {boolean}
*/
function hasAwsContainerApi() {
if (process.env.ECS_CONTAINER_METADATA_URI_V4 != null) {
return true
}
return process.env.ECS_CONTAINER_METADATA_URI != null
}
/**
* Increments a supportability metric to indicate that there was an error
* while trying to read the boot id from the system.
*
* @param {object} agent Newrelic agent instance.
*/
function recordBootIdError(agent) {
agent.metrics.getOrCreateMetric(NAMES.UTILIZATION.BOOT_ID_ERROR).incrementCallCount()
}
/**
* Utility function to parse a Docker boot id from a cgroup proc file.
*
* @param {Buffer} data The information from the proc file.
* @param {object} agent Newrelic agent instance.
* @param {Function} callback Typical error first callback. Second parameter
* is the boot id as a string.
*
* @returns {*}
*/
function readProcBootId({ data, agent, callback }) {
if (!data) {
recordBootIdError(agent)
return callback(null, null)
}
data = data.trim()
const asciiData = Buffer.from(data, 'ascii').toString()
if (data !== asciiData) {
recordBootIdError(agent)
return callback(null, null)
}
if (data.length !== 36) {
recordBootIdError(agent)
if (data.length > 128) {
data = data.substring(0, 128)
}
}
return callback(null, data)
}
/**
* Attempt to extract container id from either cgroups v1 or v2 file
*
* @param {object} agent NR instance
* @param {Function} callback function to call when done
* @param {object} [logger] internal logger instance
*/
function fetchDockerVendorInfo(agent, callback, logger = log) {
if (!agent.config.utilization || !agent.config.utilization.detect_docker) {
return callback(null, null)
}
if (vendorInfo) {
return callback(null, vendorInfo)
}
if (!os.platform().match(/linux/i)) {
logger.debug('Platform is not a flavor of linux, omitting docker info')
return callback(null, null)
}
// try v2 path first and if null try parsing v1 path
common.readProc(CGROUPS_V2_PATH, function getV2CGroup(err, data) {
if (data === null) {
logger.debug(
`${CGROUPS_V2_PATH} not found, trying to parse container id from ${CGROUPS_V1_PATH}`
)
findCGroupsV1(callback)
return
}
parseCGroupsV2(data, callback)
})
}
/**
* Try extracting container id from a /proc/self/mountinfo
* e.g. - `528 519 254:1 /docker/containers/84cf3472a20d1bfb4b50e48b6ff50d96dfcd812652d76dd907951e6f98997bce/resolv.conf`
*
* @param {string} data file contents
* @param {Function} callback function to call when done
* @param {object} [logger] internal logger instance
*/
function parseCGroupsV2(data, callback, logger = log) {
const containerLine = new RegExp('/docker/containers/([0-9a-f]{64})/')
const line = containerLine.exec(data)
if (line) {
callback(null, { id: line[1] })
} else {
logger.debug(`Found ${CGROUPS_V2_PATH} but failed to parse Docker container id.`)
callback(null, null)
}
}
/**
* Read /proc/self/cgroup and try to extract the container id from a cpu line
* e.g. - `4:cpu:/docker/f37a7e4d17017e7bf774656b19ca4360c6cdc4951c86700a464101d0d9ce97ee`
*
* @param {Function} callback function to call when done
* @param {object} [logger] internal logger instance
*/
function findCGroupsV1(callback, logger = log) {
common.readProc(CGROUPS_V1_PATH, function getCGroup(err, data) {
if (!data) {
logger.debug(`${CGROUPS_V1_PATH} not found, exiting parsing containerId.`)
return callback(null)
}
let id = null
parseCGroupsV1(data, 'cpu', function forEachCpuGroup(cpuGroup) {
const match = /(?:^|[^0-9a-f])([0-9a-f]{64})(?:[^0-9a-f]|$)/.exec(cpuGroup)
if (match) {
id = match[1]
return false
}
return true
})
if (id) {
vendorInfo = { id: id }
callback(null, vendorInfo)
} else {
logger.debug('No matching cpu group found.')
callback(null, null)
}
})
}
/**
* Iterate line by line to extract the container id from the cpu stanza
*
* @param {string} info contents of file
* @param {string} cgroup value is cpu
* @param {Function} eachCb funtion to test if the container id exists
*/
function parseCGroupsV1(info, cgroup, eachCb) {
const target = new RegExp('^\\d+:[^:]*?\\b' + cgroup + '\\b[^:]*:')
const lines = info.split('\n')
for (let i = 0; i < lines.length; ++i) {
const line = lines[i]
if (target.test(line) && !eachCb(line.split(':')[2])) {
break
}
}
}