- Configuration data from the Ops Manager API.
- Optional certificate data from the CredHub API.
- Optional app, task and service instance usage data from the Usage Service API.
Pivotal uses this information to do the following:
- Improve its products and services.
- Fix problems.
- Advise customers on how best to deploy and use Pivotal products.
- Provide better customer support.
1. Download the scripts required to run "Pivotal Telemetry Collector" using this URL from Pivotal Network
https://network.pivotal.io/products/pivotal-telemetry-collector/
2. Extract to file system. You will notice 3 executables use the right one for your OS, in my case it was the Mac OSX executable "telemetry-collector-darwin-amd64"
-rwxr-xr-x 1 papicella staff 14877449 5 Oct 00:42 telemetry-collector-linux-amd64*
-rwxr-xr-x 1 papicella staff 14771312 5 Oct 00:42 telemetry-collector-darwin-amd64*
-rwxr-xr-x 1 papicella staff 14447104 5 Oct 00:42 telemetry-collector-windows-amd64.exe*
3. Make sure you have network access to your PCF env. You will need to hit the Operations Manager URL as well as the CF CLI API and usage service API endpoints as shown below
Ops Manager endpoint
$ ping opsmgr-02.haas-yyy.pez.pivotal.io
PING opsmgr-02.haas-yyy.pez.pivotal.io (10.195.1.1): 56 data bytes
64 bytes from 10.195.1.1: icmp_seq=0 ttl=58 time=338.412 ms
CF API endpoint
$ ping api.system.run.haas-yyy.pez.pivotal.io
PING api.system.run.haas-yyy.pez.pivotal.io (10.195.1.2): 56 data bytes
64 bytes from 10.195.1.2: icmp_seq=0 ttl=58 time=380.852 ms
Usage Service API endpoint
$ ping app-usage.system.run.haas-yyy.pez.pivotal.io
PING app-usage.system.run.haas-yyy.pez.pivotal.io (10.195.1.3): 56 data bytes
64 bytes from 10.195.1.3: icmp_seq=0 ttl=58 time=495.996 ms
4. Now you can use this via two options. As you would of guessed we are using the CLI given we have downloaded the scripts.
Concourse: https://docs.pivotal.io/telemetry/1-1/using-concourse.html
CLI: https://docs.pivotal.io/telemetry/1-1/using-cli.html
5. So to run out first collect we would run the collector script as follows. More information about what the CLI options are can be found on this link or using help option "./telemetry-collector-darwin-amd64 --help"
https://docs.pivotal.io/telemetry/1-1/using-cli.html
Script Name: run-with-usage.sh
$ ./telemetry-collector-darwin-amd64 collect --url https://opsmgr-02.haas-yyy.pez.pivotal.io/ --username admin --password {PASSWD} --env-type production --output-dir output --usage-service-url https://app-usage.system.run.haas-yyy.pez.pivotal.io/ --usage-service-client-id push_usage_service --usage-service-client-secret {PUSH-USAGE-SERVICE-PASSWORD} --usage-service-insecure-skip-tls-verify --insecure-skip-tls-verify --cf-api-url https://api.system.run.haas-yyy.pez.pivotal.io
Note: You would obtain the PUSH-USAGE-SERVICE-PASSWORD from Ops Manager PAS tile credentials tab as shown in screen shot below
6. All set let's try it out
$ ./run-with-usage.sh
Collecting data from Operations Manager at https://opsmgr-02.haas-yyy.pez.pivotal.io/
Collecting data from Usage Service at https://app-usage.system.run.haas-yyy.pez.pivotal.io/
Wrote output to output/FoundationDetails_1571355194.tar
Success!
7. Let's extract the output TAR as follows
$ cd output/
$ tar -xvf FoundationDetails_1571355194.tar
x opsmanager/ops_manager_deployed_products
x opsmanager/pivotal-container-service_resources
x opsmanager/pivotal-container-service_properties
x opsmanager/pivotal-mysql_resources
x opsmanager/pivotal-mysql_properties
x opsmanager/cf_resources
x opsmanager/cf_properties
x opsmanager/p-compliance-scanner_resources
x opsmanager/p-compliance-scanner_properties
x opsmanager/ops_manager_vm_types
x opsmanager/ops_manager_diagnostic_report
x opsmanager/ops_manager_installations
x opsmanager/ops_manager_certificates
x opsmanager/ops_manager_certificate_authorities
x opsmanager/metadata
x usage_service/app_usage
x usage_service/service_usage
x usage_service/task_usage
x usage_service/metadata
7. Now let's view the output which is a SET of JSON files and to do that I simply use "cat" command and pipe that to JQ as shown below
$ cat ./output/opsmanager/ops_manager_installations | jq -r
{
"installations": [
{
"additions": [
{
"change_type": "addition",
"deployment_status": "successful",
"guid": "p-compliance-scanner-a53448be03a372a13d89",
"identifier": "p-compliance-scanner",
"label": "Compliance Scanner for PCF",
"product_version": "1.0.0"
}
],
"deletions": [],
"finished_at": "2019-08-30T09:38:29.679Z",
"id": 25,
"started_at": "2019-08-30T09:21:44.810Z",
"status": "failed",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
}
],
"updates": []
},
{
"additions": [],
"deletions": [
{
"change_type": "deletion",
"deployment_status": "pending",
"guid": "p-compliance-scanner-1905a6707e4f434e315a",
"identifier": "p-compliance-scanner",
"label": "Compliance Scanner for PCF",
"product_version": "1.0.0-beta.25"
}
],
"finished_at": "2019-08-08T02:10:51.130Z",
"id": 24,
"started_at": "2019-08-08T02:09:10.290Z",
"status": "succeeded",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
}
],
"updates": []
},
{
"additions": [],
"deletions": [],
"finished_at": "2019-07-18T12:27:54.301Z",
"id": 23,
"started_at": "2019-07-18T11:31:19.781Z",
"status": "succeeded",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
}
],
"updates": [
{
"change_type": "update",
"deployment_status": "successful",
"guid": "cf-3095a0a264aa5900d79f",
"identifier": "cf",
"label": "Small Footprint PAS",
"product_version": "2.5.3"
}
]
},
{
"additions": [],
"deletions": [
{
"change_type": "deletion",
"deployment_status": "pending",
"guid": "pas-windows-72031f60ab052fa4d473",
"identifier": "pas-windows",
"label": "Pivotal Application Service for Windows",
"product_version": "2.5.2"
}
],
"finished_at": "2019-07-07T00:16:31.948Z",
"id": 22,
"started_at": "2019-07-07T00:04:32.974Z",
"status": "succeeded",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
}
],
"updates": []
},
{
"additions": [],
"deletions": [],
"finished_at": "2019-07-07T00:02:12.003Z",
"id": 21,
"started_at": "2019-07-06T23:57:06.401Z",
"status": "failed",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
}
],
"updates": [
{
"change_type": "update",
"deployment_status": "failed",
"guid": "pas-windows-72031f60ab052fa4d473",
"identifier": "pas-windows",
"label": "Pivotal Application Service for Windows",
"product_version": "2.5.2"
}
]
},
{
"additions": [
{
"change_type": "addition",
"deployment_status": "successful",
"guid": "p-compliance-scanner-1905a6707e4f434e315a",
"identifier": "p-compliance-scanner",
"label": "Compliance Scanner for PCF",
"product_version": "1.0.0-beta.25"
}
],
"deletions": [],
"finished_at": "2019-06-10T09:23:19.595Z",
"id": 20,
"started_at": "2019-06-10T09:10:44.431Z",
"status": "succeeded",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
}
],
"updates": []
},
{
"additions": [
{
"change_type": "addition",
"deployment_status": "skipped",
"guid": "aquasec-1b94477ae275ee81be58",
"identifier": "aquasec",
"label": "Aqua Security for PCF",
"product_version": "1.0.0"
}
],
"deletions": [],
"finished_at": "2019-06-06T17:38:18.396Z",
"id": 19,
"started_at": "2019-06-06T17:35:34.614Z",
"status": "failed",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
}
],
"updates": []
},
{
"additions": [
{
"change_type": "addition",
"deployment_status": "skipped",
"guid": "aquasec-1b94477ae275ee81be58",
"identifier": "aquasec",
"label": "Aqua Security for PCF",
"product_version": "1.0.0"
}
],
"deletions": [],
"finished_at": "2019-06-06T17:33:18.545Z",
"id": 18,
"started_at": "2019-06-06T17:21:41.529Z",
"status": "failed",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
},
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "pas-windows-72031f60ab052fa4d473",
"identifier": "pas-windows",
"label": "Pivotal Application Service for Windows",
"product_version": "2.5.2"
}
],
"updates": []
},
{
"additions": [],
"deletions": [],
"finished_at": "2019-06-04T11:15:43.546Z",
"id": 17,
"started_at": "2019-06-04T10:49:57.969Z",
"status": "succeeded",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "pas-windows-72031f60ab052fa4d473",
"identifier": "pas-windows",
"label": "Pivotal Application Service for Windows",
"product_version": "2.5.2"
},
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
}
],
"updates": []
},
{
"additions": [],
"deletions": [],
"finished_at": "2019-06-04T10:44:04.018Z",
"id": 16,
"started_at": "2019-06-04T10:17:28.230Z",
"status": "failed",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
},
{
"change_type": "unchanged",
"deployment_status": "failed",
"guid": "pas-windows-72031f60ab052fa4d473",
"identifier": "pas-windows",
"label": "Pivotal Application Service for Windows",
"product_version": "2.5.2"
}
],
"updates": []
},
{
"additions": [],
"deletions": [],
"finished_at": "2019-06-04T09:52:30.782Z",
"id": 15,
"started_at": "2019-06-04T09:48:45.867Z",
"status": "failed",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
},
{
"change_type": "unchanged",
"deployment_status": "failed",
"guid": "pas-windows-72031f60ab052fa4d473",
"identifier": "pas-windows",
"label": "Pivotal Application Service for Windows",
"product_version": "2.5.2"
}
],
"updates": []
},
{
"additions": [],
"deletions": [],
"finished_at": "2019-06-04T09:21:17.245Z",
"id": 14,
"started_at": "2019-06-04T09:17:45.360Z",
"status": "failed",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
},
{
"change_type": "unchanged",
"deployment_status": "failed",
"guid": "pas-windows-72031f60ab052fa4d473",
"identifier": "pas-windows",
"label": "Pivotal Application Service for Windows",
"product_version": "2.5.2"
}
],
"updates": []
},
{
"additions": [],
"deletions": [],
"finished_at": "2019-06-04T08:50:33.333Z",
"id": 13,
"started_at": "2019-06-04T08:47:09.790Z",
"status": "succeeded",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "pas-windows-72031f60ab052fa4d473",
"identifier": "pas-windows",
"label": "Pivotal Application Service for Windows",
"product_version": "2.5.2"
},
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
}
],
"updates": []
},
{
"additions": [],
"deletions": [],
"finished_at": "2019-06-04T08:32:44.772Z",
"id": 12,
"started_at": "2019-06-04T08:23:27.386Z",
"status": "succeeded",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
},
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "pas-windows-72031f60ab052fa4d473",
"identifier": "pas-windows",
"label": "Pivotal Application Service for Windows",
"product_version": "2.5.2"
}
],
"updates": []
},
{
"additions": [],
"deletions": [],
"finished_at": "2019-06-04T08:16:41.757Z",
"id": 11,
"started_at": "2019-06-04T08:13:54.645Z",
"status": "failed",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
},
{
"change_type": "unchanged",
"deployment_status": "failed",
"guid": "pas-windows-72031f60ab052fa4d473",
"identifier": "pas-windows",
"label": "Pivotal Application Service for Windows",
"product_version": "2.5.2"
}
],
"updates": []
},
{
"additions": [],
"deletions": [],
"finished_at": "2019-06-04T01:53:50.594Z",
"id": 10,
"started_at": "2019-06-04T01:43:56.205Z",
"status": "succeeded",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
}
],
"updates": [
{
"change_type": "update",
"deployment_status": "successful",
"guid": "pas-windows-72031f60ab052fa4d473",
"identifier": "pas-windows",
"label": "Pivotal Application Service for Windows",
"product_version": "2.5.2"
}
]
},
{
"additions": [],
"deletions": [],
"finished_at": "2019-06-04T01:28:22.975Z",
"id": 9,
"started_at": "2019-06-04T01:24:52.587Z",
"status": "succeeded",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
},
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "pas-windows-72031f60ab052fa4d473",
"identifier": "pas-windows",
"label": "Pivotal Application Service for Windows",
"product_version": "2.5.2"
}
],
"updates": []
},
{
"additions": [],
"deletions": [],
"finished_at": "2019-06-03T08:37:25.961Z",
"id": 8,
"started_at": "2019-06-03T08:13:07.511Z",
"status": "succeeded",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
}
],
"updates": [
{
"change_type": "update",
"deployment_status": "successful",
"guid": "pas-windows-72031f60ab052fa4d473",
"identifier": "pas-windows",
"label": "Pivotal Application Service for Windows",
"product_version": "2.5.2"
}
]
},
{
"additions": [
{
"change_type": "addition",
"deployment_status": "successful",
"guid": "pas-windows-72031f60ab052fa4d473",
"identifier": "pas-windows",
"label": "Pivotal Application Service for Windows",
"product_version": "2.5.2"
}
],
"deletions": [],
"finished_at": "2019-06-03T04:57:06.897Z",
"id": 7,
"started_at": "2019-06-03T03:52:13.705Z",
"status": "succeeded",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
}
],
"updates": []
},
{
"additions": [
{
"change_type": "addition",
"deployment_status": "successful",
"guid": "pivotal-mysql-0e5d717f1c87c8095c9d",
"identifier": "pivotal-mysql",
"label": "MySQL for Pivotal Cloud Foundry v2",
"product_version": "2.5.4-build.51"
}
],
"deletions": [],
"finished_at": "2019-05-22T05:15:55.703Z",
"id": 6,
"started_at": "2019-05-22T04:09:49.841Z",
"status": "succeeded",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
},
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "cf-3095a0a264aa5900d79f",
"identifier": "cf",
"label": "Small Footprint PAS",
"product_version": "2.5.3"
}
],
"updates": []
},
{
"additions": [],
"deletions": [],
"finished_at": "2019-05-22T02:12:22.934Z",
"id": 5,
"started_at": "2019-05-22T01:45:28.101Z",
"status": "succeeded",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
},
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "cf-3095a0a264aa5900d79f",
"identifier": "cf",
"label": "Small Footprint PAS",
"product_version": "2.5.3"
}
],
"updates": []
},
{
"additions": [
{
"change_type": "addition",
"deployment_status": "failed",
"guid": "cf-3095a0a264aa5900d79f",
"identifier": "cf",
"label": "Small Footprint PAS",
"product_version": "2.5.3"
}
],
"deletions": [],
"finished_at": "2019-05-22T00:23:29.844Z",
"id": 4,
"started_at": "2019-05-21T23:16:42.418Z",
"status": "failed",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
}
],
"updates": []
},
{
"additions": [],
"deletions": [],
"finished_at": "2019-05-16T01:50:50.640Z",
"id": 3,
"started_at": "2019-05-16T01:45:22.438Z",
"status": "succeeded",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
}
],
"updates": [
{
"change_type": "update",
"deployment_status": "successful",
"guid": "pivotal-container-service-5c28f63410227c2221c8",
"identifier": "pivotal-container-service",
"label": "Enterprise PKS",
"product_version": "1.4.0-build.31"
}
]
},
{
"additions": [
{
"change_type": "addition",
"deployment_status": "successful",
"guid": "pivotal-container-service-5c28f63410227c2221c8",
"identifier": "pivotal-container-service",
"label": "Enterprise PKS",
"product_version": "1.4.0-build.31"
}
],
"deletions": [],
"finished_at": "2019-05-15T00:08:32.241Z",
"id": 2,
"started_at": "2019-05-14T23:33:58.105Z",
"status": "succeeded",
"unchanged": [
{
"change_type": "unchanged",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
}
],
"updates": []
},
{
"additions": [
{
"change_type": "addition",
"deployment_status": "successful",
"guid": "p-bosh-c1853604618b1b3e10fd",
"identifier": "p-bosh",
"label": "BOSH Director",
"product_version": "2.5.3-build.185"
}
],
"deletions": [],
"finished_at": "2019-05-14T23:29:47.525Z",
"id": 1,
"started_at": "2019-05-14T23:13:13.244Z",
"status": "succeeded",
"unchanged": [],
"updates": []
}
]
}
Optionally you should send this TAR file output on every ticket/case your create so support has a great snapshot of what your ENV looks like to help diagnose support issues for you.
telemetry-collector send --path --api-key
For the API-KEY please contact your Pivotal AE or Platform Architect to request that as the Telemetry team issues API key to customer's
More Information
https://docs.pivotal.io/telemetry/1-1/index.html
