├── README.md
├── linux.go
└── LICENSE


/README.md:
--------------------------------------------------------------------------------
 1 | # mackerel-plugin-linux-proc-stats
 2 | Linux processes metrics plugin for mackerel.io agent.
 3 | 
 4 | ## Synopsis
 5 | 
 6 | ```shell
 7 | mackerel-plugin-linux-proc-stats -pid=<pid>|-pidfile=<pidfile>|-process-pattern=<process pattern> [-metric-key-prefix=<metric-key-prefix>] [-tempfile=<tempfile>] [-follow-child-processes] [-include-dead-children=0]
 8 | ```
 9 | 
10 | ```shell
11 | $ ./mackerel-plugin-linux-proc-stats --help
12 | Usage of ./mackerel-plugin-linux-proc-stats:
13 |   -follow-child-processes
14 |         Follow child processes
15 |   -include-dead-children
16 |         Include dead kids in cpu sum (default true)
17 |   -metric-key-prefix string
18 |         Metric key prefix
19 |   -pid string
20 |         PID
21 |   -pidfile string
22 |         PID file
23 |   -process-pattern string
24 |         Match a command against this pattern
25 |   -tempfile string
26 |         Temp file name
27 |   -version
28 |         Version
29 | ```
30 | 
31 | ## Requirements
32 | 
33 | - [getconf](http://linux.die.net/man/1/getconf)
34 | 
35 | ## Example of mackerel-agent.conf
36 | 
37 | ```
38 | [plugin.metrics.linux_proc_stats]
39 | command = "/path/to/mackerel-plugin-linux-proc-stats -pidfile /var/run/nginx.pid -follow-child-processes"
40 | ```
41 | 
42 | ```
43 | [plugin.metrics.linux_proc_stats]
44 | command = "/path/to/mackerel-plugin-linux-proc-stats -pidfile /var/run/mackerel-agent.pid"
45 | ```
46 | 
47 | ```
48 | [plugin.metrics.linux_proc_stats]
49 | command = "/path/to/mackerel-plugin-linux-proc-stats -process-pattern 'nginx: master process'"
50 | ```
51 | 
52 | ## Example
53 | 
54 | Running threads.
55 | 
56 | ```shell
57 | $ ./mackerel-plugin-linux-proc-stats -pidfile /var/run/mackerel-agent.pid
58 | mackerel-agent_process.memory.vsize     812974080.000000        1458808344
59 | mackerel-agent_process.memory.rss       10448896.000000 1458808344
60 | mackerel-agent_process.num.running      0.000000        1458808344
61 | mackerel-agent_process.num.processes    1.000000        1458808344
62 | mackerel-agent_process.num.threads      26.000000       1458808344
63 | mackerel-agent_process.cpu.usage        0.083986        1458808344
64 | ```
65 | 
66 | Only master process.
67 | 
68 | ```shell
69 | $ ./mackerel-plugin-linux-proc-stats -pidfile /var/run/nginx.pid
70 | nginx_process.cpu.usage 0.000000        1458808477
71 | nginx_process.memory.vsize      107450368.000000        1458808477
72 | nginx_process.memory.rss        3399680.000000  1458808477
73 | nginx_process.num.running       0.000000        1458808477
74 | nginx_process.num.processes     1.000000        1458808477
75 | nginx_process.num.threads       1.000000        1458808477
76 | ```
77 | 
78 | Master process and worker processes.
79 | 
80 | ```shell
81 | $ ./mackerel-plugin-linux-proc-stats -pidfile /var/run/nginx.pid -follow-child-processes
82 | nginx_process.num.running       0.000000        1458808496
83 | nginx_process.num.processes     2.000000        1458808496
84 | nginx_process.num.threads       2.000000        1458808496
85 | nginx_process.cpu.usage 0.000095        1458808496
86 | nginx_process.memory.vsize      215269376.000000        1458808496
87 | nginx_process.memory.rss        7966720.000000  1458808496
88 | ```
89 | 


--------------------------------------------------------------------------------
/linux.go:
--------------------------------------------------------------------------------
  1 | package main
  2 | 
  3 | import (
  4 | 	"bufio"
  5 | 	"flag"
  6 | 	"fmt"
  7 | 	mp "github.com/mackerelio/go-mackerel-plugin-helper"
  8 | 	"github.com/mackerelio/mackerel-agent/logging"
  9 | 	"io/ioutil"
 10 | 	"os"
 11 | 	"os/exec"
 12 | 	"regexp"
 13 | 	"strconv"
 14 | 	"strings"
 15 | 	"syscall"
 16 | )
 17 | 
 18 | var logger = logging.GetLogger("metrics.plugin.linux-proc-stats")
 19 | 
 20 | // /proc/PID/stat fileds
 21 | const (
 22 | 	Comm       = 1
 23 | 	State      = 2
 24 | 	UTime      = 13
 25 | 	STime      = 14
 26 | 	CUTime     = 15
 27 | 	CSTime     = 16
 28 | 	NumThreads = 19
 29 | 	StartTime  = 21
 30 | 	VSize      = 22
 31 | 	Rss        = 23
 32 | )
 33 | 
 34 | // Process Status
 35 | type Process struct {
 36 | 	State      string
 37 | 	UTime      float64
 38 | 	STime      float64
 39 | 	CUTime     float64
 40 | 	CSTime     float64
 41 | 	StartTime  float64
 42 | 	NumThreads float64
 43 | 	VSize      float64
 44 | 	RSS        float64
 45 | }
 46 | 
 47 | // Processes slice of Process
 48 | type Processes []Process
 49 | 
 50 | var uptime float64
 51 | var cpuTick float64
 52 | var metricKey string
 53 | 
 54 | // CPUUsage retrieve cpu usage
 55 | func (p *Process) CPUUsage(includeDeadChildren bool) float64 {
 56 | 	total := p.UTime + p.STime
 57 | 	if includeDeadChildren {
 58 | 		total += p.CUTime + p.CSTime
 59 | 	}
 60 | 
 61 | 	sec := uptime - (p.StartTime / cpuTick)
 62 | 	return 100 * ((total / cpuTick) / sec)
 63 | }
 64 | 
 65 | // LinuxProcStatsPlugin mackerel plugin for Linux processes
 66 | type LinuxProcStatsPlugin struct {
 67 | 	Tempfile             string
 68 | 	Pid                  string
 69 | 	Pids                 []string
 70 | 	FollowChildProcesses bool
 71 | 	IncludeDeadChildren  bool
 72 | }
 73 | 
 74 | // FetchMetrics interface for mackerelplugin
 75 | func (lp LinuxProcStatsPlugin) FetchMetrics() (stats map[string]interface{}, err error) {
 76 | 	ps := make(Processes, 0)
 77 | 
 78 | 	if len(lp.Pids) > 0 {
 79 | 		for _, pid := range lp.Pids {
 80 | 			p, err := readProcPIDStat(statFile(pid))
 81 | 			if err != nil {
 82 | 				return stats, err
 83 | 			}
 84 | 
 85 | 			ps = append(ps, p)
 86 | 		}
 87 | 	} else {
 88 | 		p, err := readProcPIDStat(statFile(lp.Pid))
 89 | 		if err != nil {
 90 | 			return stats, err
 91 | 		}
 92 | 
 93 | 		ps = append(ps, p)
 94 | 
 95 | 		if lp.FollowChildProcesses {
 96 | 			options := []string{"--ppid", lp.Pid, "-o", "pid", "--no-headers"}
 97 | 			ps, err = childStats(ps, options)
 98 | 			if err != nil {
 99 | 				return stats, err
100 | 			}
101 | 		}
102 | 	}
103 | 
104 | 	running, numThreads, vSize, rss, cpuUsage := sumStats(ps, lp.IncludeDeadChildren)
105 | 	stats = make(map[string]interface{})
106 | 	stats["running"] = running
107 | 	stats["processes"] = float64(len(ps))
108 | 	stats["threads"] = numThreads
109 | 	stats["vsize"] = vSize
110 | 	stats["rss"] = rss
111 | 	stats["usage"] = cpuUsage
112 | 
113 | 	return stats, err
114 | }
115 | 
116 | // GraphDefinition interface for mackerelplugin
117 | func (lp LinuxProcStatsPlugin) GraphDefinition() map[string](mp.Graphs) {
118 | 	comm, err := readProcPIDComm(lp.Pid)
119 | 	if err != nil {
120 | 		logger.Errorf("Failed to read /proc/PID/stat comm. %s", err)
121 | 		return map[string](mp.Graphs){}
122 | 	}
123 | 
124 | 	return map[string](mp.Graphs){
125 | 		fmt.Sprintf("%s_process.num", comm): mp.Graphs{
126 | 			Label: fmt.Sprintf("%v Running", comm),
127 | 			Unit:  "integer",
128 | 			Metrics: [](mp.Metrics){
129 | 				mp.Metrics{Name: "running", Label: "Current Running Processes", Diff: false},
130 | 				mp.Metrics{Name: "processes", Label: "All Processes", Diff: false},
131 | 				mp.Metrics{Name: "threads", Label: "Num Threads", Diff: false},
132 | 			},
133 | 		},
134 | 		fmt.Sprintf("%s_process.cpu", comm): mp.Graphs{
135 | 			Label: fmt.Sprintf("%v CPU", comm),
136 | 			Unit:  "float",
137 | 			Metrics: [](mp.Metrics){
138 | 				mp.Metrics{Name: "usage", Label: "CPU Usage", Stacked: true, Diff: false},
139 | 			},
140 | 		},
141 | 		fmt.Sprintf("%s_process.memory", comm): mp.Graphs{
142 | 			Label: fmt.Sprintf("%v Memory", comm),
143 | 			Unit:  "bytes",
144 | 			Metrics: [](mp.Metrics){
145 | 				mp.Metrics{Name: "vsize", Label: "Vsize", Stacked: false, Diff: false},
146 | 				mp.Metrics{Name: "rss", Label: "RSS", Stacked: false, Diff: false},
147 | 			},
148 | 		},
149 | 	}
150 | }
151 | 
152 | func readPIDFile(f string) (pid string, err error) {
153 | 	fp, err := os.Open(f)
154 | 	if err != nil {
155 | 		return pid, err
156 | 	}
157 | 	defer fp.Close()
158 | 
159 | 	scanner := bufio.NewScanner(fp)
160 | 	scanner.Scan()
161 | 	pid = scanner.Text()
162 | 
163 | 	return pid, err
164 | }
165 | 
166 | func readStatFile(f string) ([]string, error) {
167 | 	b, err := ioutil.ReadFile(f)
168 | 	if err != nil {
169 | 		return []string{""}, err
170 | 	}
171 | 
172 | 	s := strings.Split(string(b), " ")
173 | 	return s, err
174 | }
175 | 
176 | func readProcPIDComm(pid string) (comm string, err error) {
177 | 	if metricKey == "" {
178 | 		s, err := readStatFile(statFile(pid))
179 | 		if err != nil {
180 | 			return comm, err
181 | 		}
182 | 		comm = strings.Trim(s[Comm], "()")
183 | 	} else {
184 | 		comm = metricKey
185 | 	}
186 | 
187 | 	return comm, err
188 | }
189 | 
190 | func readProcPIDStat(f string) (p Process, err error) {
191 | 	s, err := readStatFile(f)
192 | 	if err != nil {
193 | 		return p, err
194 | 	}
195 | 
196 | 	numThreads, err := strconv.ParseFloat(s[NumThreads], 64)
197 | 	if err != nil {
198 | 		return p, err
199 | 	}
200 | 
201 | 	vSize, err := strconv.ParseFloat(s[VSize], 64)
202 | 	if err != nil {
203 | 		return p, err
204 | 	}
205 | 
206 | 	rss, err := strconv.ParseFloat(s[Rss], 64)
207 | 	if err != nil {
208 | 		return p, err
209 | 	}
210 | 
211 | 	utime, err := strconv.ParseFloat(s[UTime], 64)
212 | 	if err != nil {
213 | 		return p, err
214 | 	}
215 | 
216 | 	stime, err := strconv.ParseFloat(s[STime], 64)
217 | 	if err != nil {
218 | 		return p, err
219 | 	}
220 | 
221 | 	cutime, err := strconv.ParseFloat(s[CUTime], 64)
222 | 	if err != nil {
223 | 		return p, err
224 | 	}
225 | 
226 | 	cstime, err := strconv.ParseFloat(s[CSTime], 64)
227 | 	if err != nil {
228 | 		return p, err
229 | 	}
230 | 
231 | 	startTime, err := strconv.ParseFloat(s[StartTime], 64)
232 | 	if err != nil {
233 | 		return p, err
234 | 	}
235 | 
236 | 	p = Process{
237 | 		State:      s[State],
238 | 		NumThreads: numThreads,
239 | 		VSize:      vSize,
240 | 		RSS:        rss * float64(os.Getpagesize()),
241 | 		UTime:      utime,
242 | 		STime:      stime,
243 | 		CUTime:     cutime,
244 | 		CSTime:     cstime,
245 | 		StartTime:  startTime,
246 | 	}
247 | 
248 | 	return p, err
249 | }
250 | 
251 | func statFile(pid string) string {
252 | 	return fmt.Sprintf("/proc/%v/stat", strings.TrimSpace(pid))
253 | }
254 | 
255 | func childStats(ps Processes, options []string) (Processes, error) {
256 | 	cmd := exec.Command("ps", options...)
257 | 
258 | 	stdout, err := cmd.StdoutPipe()
259 | 	if err != nil {
260 | 		return ps, err
261 | 	}
262 | 
263 | 	cmd.Start()
264 | 	scanner := bufio.NewScanner(stdout)
265 | 
266 | 	var p Process
267 | 	for scanner.Scan() {
268 | 		childPid := scanner.Text()
269 | 		p, err = readProcPIDStat(statFile(childPid))
270 | 		if err == nil {
271 | 			ps = append(ps, p)
272 | 		}
273 | 	}
274 | 
275 | 	cmd.Wait()
276 | 
277 | 	return ps, err
278 | }
279 | 
280 | func sumStats(
281 | 	ps Processes,
282 | 	includeDeadChildren bool,
283 | ) (running, numThreads, vSize, rss, cpuUsage float64) {
284 | 	for _, p := range ps {
285 | 		if p.State == `R` {
286 | 			running++
287 | 		}
288 | 		numThreads += p.NumThreads
289 | 		vSize += p.VSize
290 | 		rss += p.RSS
291 | 		cpuUsage += p.CPUUsage(includeDeadChildren)
292 | 	}
293 | 
294 | 	return running, numThreads, vSize, rss, cpuUsage
295 | }
296 | 
297 | func getCPUTick() (tick float64, err error) {
298 | 	var out []byte
299 | 	out, err = exec.Command("/usr/bin/getconf", "CLK_TCK").Output()
300 | 
301 | 	if err != nil {
302 | 		return tick, err
303 | 	}
304 | 
305 | 	tick, err = strconv.ParseFloat(strings.TrimSpace(string(out)), 64)
306 | 
307 | 	return tick, err
308 | }
309 | 
310 | func getUptime() (float64, error) {
311 | 	sysinfo := syscall.Sysinfo_t{}
312 | 	err := syscall.Sysinfo(&sysinfo)
313 | 
314 | 	return float64(sysinfo.Uptime), err
315 | }
316 | 
317 | func getPIDsByProcessPattern(pat string) (pids []string, err error) {
318 | 	r, err := regexp.Compile(pat)
319 | 	if err != nil {
320 | 		return pids, fmt.Errorf("Failed to compile %s. %s", pat, err)
321 | 	}
322 | 
323 | 	res, err := getPSResult()
324 | 	if err != nil {
325 | 		return pids, fmt.Errorf("Failed to getPSResult. %s", err)
326 | 	}
327 | 
328 | 	pids = make([]string, 0)
329 | 	p, pp := strconv.Itoa(os.Getpid()), strconv.Itoa(os.Getppid())
330 | 	for _, ps := range res {
331 | 		if !r.MatchString(ps.cmd) {
332 | 			continue
333 | 		}
334 | 		if ps.pid == p {
335 | 			continue
336 | 		}
337 | 		if ps.pid == pp {
338 | 			continue
339 | 		}
340 | 		pids = append(pids, ps.pid)
341 | 	}
342 | 
343 | 	return pids, nil
344 | }
345 | 
346 | type psResult struct {
347 | 	pid string
348 | 	cmd string
349 | }
350 | 
351 | func getPSResult() (res []psResult, err error) {
352 | 	psformat := "pid,command"
353 | 	output, err := exec.Command("ps", "axwwo", psformat).Output()
354 | 	if err != nil {
355 | 		return res, err
356 | 	}
357 | 
358 | 	for _, line := range strings.Split(string(output), "\n")[1:] {
359 | 		if line == "" {
360 | 			continue
361 | 		}
362 | 
363 | 		r, err := parsePSResult(line)
364 | 		if err != nil {
365 | 			return res, err
366 | 		}
367 | 		res = append(res, r)
368 | 	}
369 | 	return res, nil
370 | }
371 | 
372 | func parsePSResult(line string) (r psResult, err error) {
373 | 	fields := strings.Fields(line)
374 | 	fieldsMinLen := 2
375 | 	if len(fields) < fieldsMinLen {
376 | 		return r, fmt.Errorf(
377 | 			"parsePSResult: insufficient words. line=%s, fields=%v",
378 | 			line, fields,
379 | 		)
380 | 	}
381 | 	return psResult{fields[0], strings.Join(fields[1:], " ")}, nil
382 | }
383 | 
384 | func main() {
385 | 	optPID := flag.String("pid", "", "PID")
386 | 	optPIDFile := flag.String("pidfile", "", "PID file")
387 | 	optProcPat := flag.String("process-pattern", "", "Match a command against this pattern")
388 | 	optTempfile := flag.String("tempfile", "", "Temp file name")
389 | 	optFollowChildProcesses := flag.Bool("follow-child-processes", false, "Follow child processes")
390 | 	optMetricKey := flag.String("metric-key-prefix", "", "Metric key prefix")
391 | 	optVersion := flag.Bool("version", false, "Version")
392 | 	optIncludeDeadChildren := flag.Bool("include-dead-children", true, "Include dead kids in cpu sum")
393 | 	flag.Parse()
394 | 
395 | 	if *optVersion {
396 | 		fmt.Println("0.3")
397 | 		os.Exit(0)
398 | 	}
399 | 
400 | 	var pid string
401 | 	var pids []string
402 | 	var err error
403 | 
404 | 	if *optProcPat != "" {
405 | 		pids, err = getPIDsByProcessPattern(*optProcPat)
406 | 		if err != nil {
407 | 			logger.Errorf("Failed to match %s. %s", *optProcPat, err)
408 | 		}
409 | 	} else {
410 | 		if *optPID != "" {
411 | 			pid = *optPID
412 | 		} else {
413 | 			pid, err = readPIDFile(*optPIDFile)
414 | 			if err != nil {
415 | 				logger.Errorf("Failed to read /proc/%s/stat. %s", pid, err)
416 | 			}
417 | 		}
418 | 	}
419 | 
420 | 	metricKey = *optMetricKey
421 | 
422 | 	var procStats LinuxProcStatsPlugin
423 | 	procStats.Pid = pid
424 | 	procStats.Pids = pids
425 | 	procStats.FollowChildProcesses = *optFollowChildProcesses
426 | 	procStats.IncludeDeadChildren = *optIncludeDeadChildren
427 | 
428 | 	uptime, err = getUptime()
429 | 	if err != nil {
430 | 		logger.Errorf("Failed to fetch uptime. %s", err)
431 | 	}
432 | 
433 | 	cpuTick, err = getCPUTick()
434 | 	if err != nil {
435 | 		logger.Errorf("Failed to fetch cputick. %s", err)
436 | 	}
437 | 
438 | 	helper := mp.NewMackerelPlugin(procStats)
439 | 	if *optTempfile != "" {
440 | 		helper.Tempfile = *optTempfile
441 | 	} else {
442 | 		helper.Tempfile = "/tmp/mackerel-plugin-linux-proc-stats"
443 | 	}
444 | 
445 | 	helper.Run()
446 | }
447 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                                  Apache License
  2 |                            Version 2.0, January 2004
  3 |                         http://www.apache.org/licenses/
  4 | 
  5 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  6 | 
  7 |    1. Definitions.
  8 | 
  9 |       "License" shall mean the terms and conditions for use, reproduction,
 10 |       and distribution as defined by Sections 1 through 9 of this document.
 11 | 
 12 |       "Licensor" shall mean the copyright owner or entity authorized by
 13 |       the copyright owner that is granting the License.
 14 | 
 15 |       "Legal Entity" shall mean the union of the acting entity and all
 16 |       other entities that control, are controlled by, or are under common
 17 |       control with that entity. For the purposes of this definition,
 18 |       "control" means (i) the power, direct or indirect, to cause the
 19 |       direction or management of such entity, whether by contract or
 20 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 21 |       outstanding shares, or (iii) beneficial ownership of such entity.
 22 | 
 23 |       "You" (or "Your") shall mean an individual or Legal Entity
 24 |       exercising permissions granted by this License.
 25 | 
 26 |       "Source" form shall mean the preferred form for making modifications,
 27 |       including but not limited to software source code, documentation
 28 |       source, and configuration files.
 29 | 
 30 |       "Object" form shall mean any form resulting from mechanical
 31 |       transformation or translation of a Source form, including but
 32 |       not limited to compiled object code, generated documentation,
 33 |       and conversions to other media types.
 34 | 
 35 |       "Work" shall mean the work of authorship, whether in Source or
 36 |       Object form, made available under the License, as indicated by a
 37 |       copyright notice that is included in or attached to the work
 38 |       (an example is provided in the Appendix below).
 39 | 
 40 |       "Derivative Works" shall mean any work, whether in Source or Object
 41 |       form, that is based on (or derived from) the Work and for which the
 42 |       editorial revisions, annotations, elaborations, or other modifications
 43 |       represent, as a whole, an original work of authorship. For the purposes
 44 |       of this License, Derivative Works shall not include works that remain
 45 |       separable from, or merely link (or bind by name) to the interfaces of,
 46 |       the Work and Derivative Works thereof.
 47 | 
 48 |       "Contribution" shall mean any work of authorship, including
 49 |       the original version of the Work and any modifications or additions
 50 |       to that Work or Derivative Works thereof, that is intentionally
 51 |       submitted to Licensor for inclusion in the Work by the copyright owner
 52 |       or by an individual or Legal Entity authorized to submit on behalf of
 53 |       the copyright owner. For the purposes of this definition, "submitted"
 54 |       means any form of electronic, verbal, or written communication sent
 55 |       to the Licensor or its representatives, including but not limited to
 56 |       communication on electronic mailing lists, source code control systems,
 57 |       and issue tracking systems that are managed by, or on behalf of, the
 58 |       Licensor for the purpose of discussing and improving the Work, but
 59 |       excluding communication that is conspicuously marked or otherwise
 60 |       designated in writing by the copyright owner as "Not a Contribution."
 61 | 
 62 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 63 |       on behalf of whom a Contribution has been received by Licensor and
 64 |       subsequently incorporated within the Work.
 65 | 
 66 |    2. Grant of Copyright License. Subject to the terms and conditions of
 67 |       this License, each Contributor hereby grants to You a perpetual,
 68 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 69 |       copyright license to reproduce, prepare Derivative Works of,
 70 |       publicly display, publicly perform, sublicense, and distribute the
 71 |       Work and such Derivative Works in Source or Object form.
 72 | 
 73 |    3. Grant of Patent License. Subject to the terms and conditions of
 74 |       this License, each Contributor hereby grants to You a perpetual,
 75 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 76 |       (except as stated in this section) patent license to make, have made,
 77 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 78 |       where such license applies only to those patent claims licensable
 79 |       by such Contributor that are necessarily infringed by their
 80 |       Contribution(s) alone or by combination of their Contribution(s)
 81 |       with the Work to which such Contribution(s) was submitted. If You
 82 |       institute patent litigation against any entity (including a
 83 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 84 |       or a Contribution incorporated within the Work constitutes direct
 85 |       or contributory patent infringement, then any patent licenses
 86 |       granted to You under this License for that Work shall terminate
 87 |       as of the date such litigation is filed.
 88 | 
 89 |    4. Redistribution. You may reproduce and distribute copies of the
 90 |       Work or Derivative Works thereof in any medium, with or without
 91 |       modifications, and in Source or Object form, provided that You
 92 |       meet the following conditions:
 93 | 
 94 |       (a) You must give any other recipients of the Work or
 95 |           Derivative Works a copy of this License; and
 96 | 
 97 |       (b) You must cause any modified files to carry prominent notices
 98 |           stating that You changed the files; and
 99 | 
100 |       (c) You must retain, in the Source form of any Derivative Works
101 |           that You distribute, all copyright, patent, trademark, and
102 |           attribution notices from the Source form of the Work,
103 |           excluding those notices that do not pertain to any part of
104 |           the Derivative Works; and
105 | 
106 |       (d) If the Work includes a "NOTICE" text file as part of its
107 |           distribution, then any Derivative Works that You distribute must
108 |           include a readable copy of the attribution notices contained
109 |           within such NOTICE file, excluding those notices that do not
110 |           pertain to any part of the Derivative Works, in at least one
111 |           of the following places: within a NOTICE text file distributed
112 |           as part of the Derivative Works; within the Source form or
113 |           documentation, if provided along with the Derivative Works; or,
114 |           within a display generated by the Derivative Works, if and
115 |           wherever such third-party notices normally appear. The contents
116 |           of the NOTICE file are for informational purposes only and
117 |           do not modify the License. You may add Your own attribution
118 |           notices within Derivative Works that You distribute, alongside
119 |           or as an addendum to the NOTICE text from the Work, provided
120 |           that such additional attribution notices cannot be construed
121 |           as modifying the License.
122 | 
123 |       You may add Your own copyright statement to Your modifications and
124 |       may provide additional or different license terms and conditions
125 |       for use, reproduction, or distribution of Your modifications, or
126 |       for any such Derivative Works as a whole, provided Your use,
127 |       reproduction, and distribution of the Work otherwise complies with
128 |       the conditions stated in this License.
129 | 
130 |    5. Submission of Contributions. Unless You explicitly state otherwise,
131 |       any Contribution intentionally submitted for inclusion in the Work
132 |       by You to the Licensor shall be under the terms and conditions of
133 |       this License, without any additional terms or conditions.
134 |       Notwithstanding the above, nothing herein shall supersede or modify
135 |       the terms of any separate license agreement you may have executed
136 |       with Licensor regarding such Contributions.
137 | 
138 |    6. Trademarks. This License does not grant permission to use the trade
139 |       names, trademarks, service marks, or product names of the Licensor,
140 |       except as required for reasonable and customary use in describing the
141 |       origin of the Work and reproducing the content of the NOTICE file.
142 | 
143 |    7. Disclaimer of Warranty. Unless required by applicable law or
144 |       agreed to in writing, Licensor provides the Work (and each
145 |       Contributor provides its Contributions) on an "AS IS" BASIS,
146 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 |       implied, including, without limitation, any warranties or conditions
148 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 |       PARTICULAR PURPOSE. You are solely responsible for determining the
150 |       appropriateness of using or redistributing the Work and assume any
151 |       risks associated with Your exercise of permissions under this License.
152 | 
153 |    8. Limitation of Liability. In no event and under no legal theory,
154 |       whether in tort (including negligence), contract, or otherwise,
155 |       unless required by applicable law (such as deliberate and grossly
156 |       negligent acts) or agreed to in writing, shall any Contributor be
157 |       liable to You for damages, including any direct, indirect, special,
158 |       incidental, or consequential damages of any character arising as a
159 |       result of this License or out of the use or inability to use the
160 |       Work (including but not limited to damages for loss of goodwill,
161 |       work stoppage, computer failure or malfunction, or any and all
162 |       other commercial damages or losses), even if such Contributor
163 |       has been advised of the possibility of such damages.
164 | 
165 |    9. Accepting Warranty or Additional Liability. While redistributing
166 |       the Work or Derivative Works thereof, You may choose to offer,
167 |       and charge a fee for, acceptance of support, warranty, indemnity,
168 |       or other liability obligations and/or rights consistent with this
169 |       License. However, in accepting such obligations, You may act only
170 |       on Your own behalf and on Your sole responsibility, not on behalf
171 |       of any other Contributor, and only if You agree to indemnify,
172 |       defend, and hold each Contributor harmless for any liability
173 |       incurred by, or claims asserted against, such Contributor by reason
174 |       of your accepting any such warranty or additional liability.
175 | 
176 |    END OF TERMS AND CONDITIONS
177 | 
178 |    APPENDIX: How to apply the Apache License to your work.
179 | 
180 |       To apply the Apache License to your work, attach the following
181 |       boilerplate notice, with the fields enclosed by brackets "{}"
182 |       replaced with your own identifying information. (Don't include
183 |       the brackets!)  The text should be enclosed in the appropriate
184 |       comment syntax for the file format. We also recommend that a
185 |       file or class name and description of purpose be included on the
186 |       same "printed page" as the copyright notice for easier
187 |       identification within third-party archives.
188 | 
189 |    Copyright {yyyy} {name of copyright owner}
190 | 
191 |    Licensed under the Apache License, Version 2.0 (the "License");
192 |    you may not use this file except in compliance with the License.
193 |    You may obtain a copy of the License at
194 | 
195 |        http://www.apache.org/licenses/LICENSE-2.0
196 | 
197 |    Unless required by applicable law or agreed to in writing, software
198 |    distributed under the License is distributed on an "AS IS" BASIS,
199 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 |    See the License for the specific language governing permissions and
201 |    limitations under the License.
202 | 
203 | 


--------------------------------------------------------------------------------