Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit 14851f8

Browse files
committed
Update Readme
1 parent 83942e4 commit 14851f8

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed
Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,62 @@
11
# Field Pack Name (Version)
2-
Docker Monitoring 1.0
2+
Docker Monitoring
33

44
# Description
55
Docker Monitoring fieldpack allows you to monitor the docker infrastructure after providing the hostname and port number on which the docker apps are running.
6-
7-
*__NOTE TO CONTRIBUTORS:__ Projects are designed to be self documenting in this README file. Rich text (including screenshots) can be found inside the projects themselves (as committed assets). Generally a project overview (including description, sample screenshots, etc.) can be found on the project wiki page at `https://github.com/ca-apm/<repo_name>/wiki`.*
6+
A project overview (including description, sample screenshots, etc.) can be found on the project wiki page at https://cawiki.ca.com/display/APMFIELDPACKS/Docker+Monitoring
87

98
## Releases
109
From time to time, projects may make compiled releases available. While source code is always available for complete build, releases serve as a "tag" (numbered release) and often contain prepared packages that are prebuilt and ready to use. Visit `https://github.com/ca-apm/<repo_name>/releases` for details.
1110

1211
## APM version
13-
*APM EM and agent versions the field pack has been tested with.*
12+
APM 9.7.1 and above
1413

1514
## Supported third party versions
16-
*Third party versions tested with.*
15+
Java 1.7 and above
16+
Docker Server API version 1.17 and above
1717

1818
## Limitations
19-
*What the field pack will not do.*
20-
21-
## License
22-
*Link to the license under which this field pack is provided. See [Licensing](https://communities.ca.com/docs/DOC-231150910#license) on the CA APM Developer Community.*
19+
No limitation
2320

21+
## License ( Need to update this section properly )
22+
Apache 2.0 licenses
23+
BouncyCastle - http://techstack.ca.com/techstack-web/content/tpsr/detail.jsp?tpsrId=00000087_19
2424
Please review the
2525
**LICENSE**
2626
file in this repository. Licenses may vary by repository. Your download and use of this software constitutes your agreement to this license.
2727

2828
# Installation Instructions
29-
*How to install the field pack.*
29+
Install, configure and run an EPAgent on the same or a remote server. See CA APM Environment Performance Agent Implementation Guide. (https://samlgwsm.ca.com/affwebservices/public/saml2sso?SAMLRequest=fZDLboMwEEV%2FxZo9GFBIKwuIUKNKSOkmjy66c1yHWAWbemzo55eAkOimS2t85s492e6nbUgvLSqj%0Ac4jDCIjUwnwqXedwOb8Gz7ArMuRt07HSu7s%2Bym8v0ZGR08imQQ7eamY4KmSatxKZE%2BxUvh1YEkas%0As8YZYRogJaK0bgx6MRp9K%2B1J2l4JeTkecrg71yGjdFBfKhQ8FKalXeNrpZGOWN9IRx9pQPZjvNLc%0ATRcv2GNUD9guKL%2FdBnnFOQBp56%2BNEtOvBNEAqfY5jF0rRC8rjY5rl0MSxWkQbYN4c45jFj%2BxdBsm%0Am%2FQDyPtiaGwEsw82sXYl4n8PfGkPxapjRle7ivn113TxCw%3D%3D&RelayState=%2Fdisplay%2FAPMDEVOPS97%2FCA+APM+Environment+Performance+Agent+Implementation+Guide)
30+
Unzip the binaries located at https://cawiki.ca.com/download/attachments/727271081/EPADocker.zip
31+
Provide necessary input under docker.properties
32+
Copy docker.typeviewers.xml to your Enterprise Manager (MOM) <EM_HOME>/ext/xmltv.
3033

3134
## Prerequisites
32-
*What has to be done before installing the field pack.*
35+
Docker Application needs to be started with -H parameter so that it can bind Docker to another host/port or a Unix socket ( both http and https )
36+
For eg.
37+
docker -d --tlsverify --tlscacert=ca.pem --tlscert=server-cert.pem --tlskey=server-key.pem -H=0.0.0.0:2376
3338

3439
## Dependencies
35-
*APM and third party dependencies. E.g. APM agent 9.1+, SOA (web services) extension 9.1+*
36-
37-
## Installation
38-
*How to install the field pack.*
40+
APM EPAgent version 9.7.1 and above
3941

4042
## Configuration
41-
*How to configure the field pack.*
42-
43+
Make sure java path is set and pointing to 1.7 and above
44+
Run startDockerMonitor.bat
4345

4446
# Usage Instructions
45-
*How to use the field pack.*
47+
4648

4749
## Metric description
48-
*Describe the metrics provided by this field pack or link to third party documentation.*
50+
4951

5052
## Custom Management Modules
51-
*Dashboards, etc. included with this field pack.*
53+
Nothing is provided OOB
5254

5355
## Custom type viewers
54-
*Type viewers included with this field pack. Include agent and metric path that the type viewer matches against.*
55-
56-
## Name Formatter Replacements
57-
*If the field pack includes name formatters cite all place holders here and what they are replaced with.*
56+
A custom typeview is supplied with the project. For more screenshots, look at "screenshots.docx"
5857

5958
## Debugging and Troubleshooting
60-
*How to debug and troubleshoot the field pack.*
59+
6160

6261
## Support
6362
This document and associated tools are made available from CA Technologies as examples and provided at no charge as a courtesy to the CA APM Community at large. This resource may require modification for use in your environment. However, please note that this resource is not supported by CA Technologies, and inclusion in this site should not be construed to be an endorsement or recommendation by CA Technologies. These utilities are not covered by the CA Technologies software license agreement and there is no explicit or implied warranty from CA Technologies. They can be used and distributed freely amongst the CA APM Community, but not sold. As such, they are unsupported software, provided as is without warranty of any kind, express or implied, including but not limited to warranties of merchantability and fitness for a particular purpose. CA Technologies does not warrant that this resource will meet your requirements or that the operation of the resource will be uninterrupted or error free or that any defects will be corrected. The use of this resource implies that you understand and agree to the terms listed herein.
@@ -78,4 +77,5 @@ Changes for each version of the field pack.
7877

7978
Version | Author | Comment
8079
--------|--------|--------
80+
1.0 | Abhijit Bhadra | Added support for https
8181
1.0 | Abhijit Bhadra | First version of the field pack.

0 commit comments

Comments
 (0)