Activate and Configure to Send Usage Data

Activate  and configure it to collect and send telemetry data, or system and usage data. Telemetry is a foundational element of the Enterprise Software Portfolio License Agreement (PLA) subscription model.
If you are using
Layer7 Live API Creator
release 5.4.1,
Layer7 Live API Creator
collects and sends usage data by way of the Broadcom telemetry endpoint,
https://telemetry.broadcom.com/loaddata
, port 443. This endpoint replaces Segment and the Segment URL in this release.
Activate
Layer7 Live API Creator
and configure it to collect and send telemetry data, or system and usage data. Telemetry is a foundational element of the Enterprise Software Portfolio License Agreement (PLA) subscription model.
Layer7 Live API Creator
collects and sends this data to Segment, a third-party cloud service. CA Technologies, a Broadcom company, uses the data to offer additional products from the portfolio in support of the PLA subscription model. Support uses the data to improve customer experience, to troubleshoot customer issues, and to improve the services that Broadcom offers.
If you are licensed to use
Layer7 Live API Creator
under a PLA, you must activate
Layer7 Live API Creator
and configure it to collect and send
Layer7 Live API Creator
-specific usage data. If you are licensed to use
Layer7 Live API Creator
under a standard license that the CA Support site issues, you can consent to
Layer7 Live API Creator
collecting and sending usage data. You do this during the activation process or later, by updating your usage data configuration. By default,
Layer7 Live API Creator
does not collect and send usage data.
Layer7 Live API Creator
collects usage data in a secure and anonymized way.
Layer7 Live API Creator
does
not
collect personally identifiable information (PII) or sensitive information, including user data.
For more information about how
Layer7 Live API Creator
collects and uses personal information, see our Privacy Statement.
For more information:
In this article:
The Usage Data that
Layer7 Live API Creator
Collects and Sends
Layer7 Live API Creator
creates the following attributes when you activate
Layer7 Live API Creator
.
Layer7 Live API Creator
sources the values for these attributes from the values that you enter in the fields during the
Layer7 Live API Creator
activation process:
> Created attributes from the information that is collected during activation
Attribute name
Type
Description
chargeback_id
String
The department or cost center that you use for internal tracking, such as the ID for billing back to groups.
Layer7 Live API Creator
activation field name:
Internal Identifier
domain_name
String
The last part of your company's email address (the domain).
Sample values:
customer.com or bank.eu
Layer7 Live API Creator
activation field name:
Company Domain
site_id
Number
The enterprise site ID that CA Support assigns to your company. The ID is visible when you log in to the CA Support site.
Sample value:
94003167
Limit:
4 to 9 digits
Layer7 Live API Creator
activation field name:
Enterprise Site ID
Layer7 Live API Creator
creates the following attributes:
> Created attributes
Attribute name
Type
Description
date_collected
String
The date that
Layer7 Live API Creator
collects your
Layer7 Live API Creator
usage data.
instance_id
String
The unique identifier that
Layer7 Live API Creator
uses to differentiate between installations.
key_name
String or Number
(Optional) The key value pairs that are specific to your
Layer7 Live API Creator
installation. For example, the value for this metric can be seat counts, artifact count, or license types.
monthly_usage
Number
Layer7 Live API Creator
calculates the value during startup.
This value defaults to 1 per running instance of
Layer7 Live API Creator
.
send_enabled
Boolean
Defines whether you have consented to
Layer7 Live API Creator
sending usage data.
Default:
false
Values:
  • true: You have consented to
    Layer7 Live API Creator
    sending usage data.
  • false: You have not consented to
    Layer7 Live API Creator
    sending usage data.
pla_enabled
Boolean
Identifies whether you are licensed to use
Layer7 Live API Creator
under a PLA or under a standard license.
Default:
false
Values:
  • true: You are licensed to use
    Layer7 Live API Creator
    under a PLA.
  • false: You are licensed to use
    Layer7 Live API Creator
    under a standard license.
product_sku
String
The
Layer7 Live API Creator
stock keeping unit (SKU). The SKU is based on the value for
install_type
.
Values:
  • Layer7 Live API Creator
    running as a Docker container: APILMC990
  • Layer7 Live API Creator
    running as a Java container: APICRT990
sku_description
String
The description of the
Layer7 Live API Creator
SKU.
product_version
String
The version of
Layer7 Live API Creator
that is running.
Example:
Layer7 Live API Creator<VersionNumber>
Layer7 Live API Creator
collects the following attributes:
> Collected attributes
Attribute name
Type
Description
api_calls_count
String
The number of daily calls to APIs other than to the
Layer7 Live API Creator
Admin project API (Admin API) and to system REST endpoints.
For more information about system REST endpoints, see System REST Endpoints.
api_projects_count
String
The total number of APIs that you have created in this instance of
Layer7 Live API Creator
.
os_version
String
The operation system of the server where
Layer7 Live API Creator
is running.
container_type
String
The Java container or type of application server and version that
Layer7 Live API Creator
is running.
Examples:
Apache Tomcat or IBM WebSphere
jvm_version
String
The version of Java virtual machine (JVM) on which
Layer7 Live API Creator
is running.
install_type
String
The platform that
Layer7 Live API Creator
is running.
Examples
: Jetty, Docker, Microsoft Azure, or AWS Elastic Beanstalk
> Sample payload for identify usage data:
{
"batch":[
{
"type":"identify",
"messageId":"4a9e0ca9-6866-48c1-b5a1-91a72fa0388c",
"timestamp":"2019-03-28T20:53:30.861Z",
"userId":"NotApplicable",
"integrations":{
},
"traits":{
"pla_enabled":0,
"product_sku":"APICRT990",
"product_version":"Layer7 Live API Creator <version>",
"domain_name":"",
"instance_id":"76b3ea45d27d12a2",
"site_id":"NotApplicable",
"sku_description":"Layer7 Live API Creator",
"chargeback_id":""
}
}
],
"sentAt":"2019-03-28T20:54:28.560Z",
"context":{
"library":{
"name":"analytics-java",
"version":"2.1.1"
}
},
"sequence":1
}
> Sample payload for track usage data:
{
"batch":[
{
"type":"track",
"messageId":"54b4c512-0204-42bd-bd9f-2202babca0c1",
"timestamp":"2019-03-08T03:45:26.755Z",
"userId":"NotApplicable",
"integrations":{
},
"event":"monthly_usage",
"properties":{
"pla_enabled":0,
"key_name":{
"api_projects_count":3,
"os_version":"Mac OS X x86_64 10.14.2",
"api_calls_count":7,
"container_type":"Apache Tomcat/8.5.24",
"datasource_types":"MYSQL,DERBY",
"jvm_version":"1.8.0_191",
"install_type":"Apache Tomcat/8.5.24"
},
"product_sku":"APICRT990",
"product_version":"Layer7 Live API Creator <version>",
"domain_name":"",
"monthly_usage":1,
"instance_id":"8ab6f47f81d72b46",
"site_id":"NotApplicable",
"sku_description":"Layer7 Live API Creator",
"date_collected":"2019-03-07",
"chargeback_id":""
}
}
],
"sentAt":"2019-03-08T03:45:53.917Z",
"context":{
"library":{
"name":"analytics-java",
"version":"2.1.1"
}
},
"sequence":2
}
Activate
Layer7 Live API Creator
and Configure it to Collect and Send Usage Data
Activating
Layer7 Live API Creator
is the process of identifying whether your
Layer7 Live API Creator
installation is licensed under a PLA or under a standard license. If
Layer7 Live API Creator
is not active, when you log in to API Creator, it prompts you to activate
Layer7 Live API Creator
and configure it to collect and send usage data.
You can activate
Layer7 Live API Creator
and configure it to collect and send usage data using the following methods:
  • During the installation and activation process.
  • During the DevOps workflow, by changing the
    system/telemetry.json
    file during the DevOps workflow. This file is part of your admin repository.
    Layer7 Live API Creator
    saves your usage data settings in this file.
    For more information:
  • By adding the telemetry startup options when you start API Server.
    For more information about the options that you can add, see API Server Startup Options.
The following procedures detail how to activate
Layer7 Live API Creator
and configure it to collect and send usage data during the installation workflow.
Activate
Layer7 Live API Creator
and configure it based on the license type:
Verify the Prerequisites
Before activating and configuring
Layer7 Live API Creator
to send usage data, verify the following prerequisites:
  • You have installed
    Layer7 Live API Creator
    .
    For more information about how to install, see Installing and Upgrading.
  • (If you are licensed to use
    Layer7 Live API Creator
    under a PLA) You know your enterprise site ID and (optionally) the identifier for your internal group or charge area. The enterprise site ID is also referred to as the customer number in your PLA. If you do not know your enterprise site ID, log in to support.ca.com and access the ID from your profile.
  • You have not already activated
    Layer7 Live API Creator
    .
  • (If you plan to configure a proxy server to send usage data) You have a proxy server set up.
    To prevent warnings messages during activation and configuration of sending usage data, start your proxy server.
Activate
Layer7 Live API Creator
Licensed Under a PLA
  1. With API Server started, log in to API Creator by entering the following URL into a browser window:
    http://localhost:8080/APICreator
    For more information about how to start API Server and log in to API Creator, see the documentation for your installation type.
    The Activate Live API Creator dialog appears.
  2. For the question "Is this install or upgrade related to new or additional planned usage under a Portfolio License Agreement (PLA)?", click
    Yes
    .
    You have identified that you are licensed to use
    Layer7 Live API Creator
    under a PLA.
  3. Complete the following fields:
    Company Domain
    Enter last part of your company's email address (the domain).
    Enterprise Site ID
    Enter the enterprise site ID that you use to access CA Support. This information is listed in your PLA and in CA Support Portal.
    Internal Identifier
    Enter the department or cost center that you use for internal tracking.
  4. (Optional) To configure a proxy server to send your usage data, select the
    Proxy
    checkbox, and then complete the following field:
    The green checkbox icons that display to the right of the proxy settings indicate that
    Layer7 Live API Creator
    successfully connected to the proxy server.
    Proxy URL
    The endpoint URL of the proxy server.
    Proxy Port
    The destination port of the proxy server.
    Proxy Username
    The authentication username for the proxy server. This field is required only if the proxy server requires the username to connect to it.
    Proxy Password
    The authentication password for the proxy server. This field is required only if the proxy server requires the password to connect to it.
    Layer7 Live API Creator
    encrypts the password that it creates in the
    telemetry.JSON
    file.
  5. Click
    Submit
    .
    Layer7 Live API Creator
    saves these settings to the
    telemetry.JSON
    file. The dialog that your activation has been successful appears.
    Layer7 Live API Creator
    is active and you have configured it to collect and send usage data. The EULA displays.
  6. Click
    Ok
    .
    The API Creator logon authentication dialog opens.
  7. Log in to API Creator.
You have activated
Layer7 Live API Creator
under a PLA.
Activate Live API Creator Under a Standard License
  1. With API Server started, log in to API Creator by entering the following URL into a browser window:
    http://localhost:8080/APICreator
    For more information about how to start API Server and log in to API Creator, see the documentation for your installation type.
    The Activate Live API Creator dialog appears.
  2. For the question "Is this install or upgrade related to new or additional planned usage under a Portfolio License Agreement (PLA)?", click
    No
    .
    You have identified that you are licensed to use
    Layer7 Live API Creator
    under a standard license. A dialog appears asking for your consent to
    Layer7 Live API Creator
    collecting and distributing usage data.
  3. For the question "Do you want to allow
    Layer7 Live API Creator
    to send usage data?", click
    Yes
    or
    No
    .
  4. If you have consented to
    Layer7 Live API Creator
    collecting and sending usage data (you have clicked
    Yes
    ), complete the following fields:
    Company Domain
    Enter the last part of your company's email address (the domain).
    Enterprise Site ID
    Enter the enterprise site ID that you use to access CA Support. This information is listed in your PLA and in CA Support Portal.
    Internal Identifier
    Enter the department or cost center that you use for internal tracking.
  5. (Optional) If you have consented to
    Layer7 Live API Creator
    collecting and sending usage data (you have clicked
    Yes
    ), you can configure a proxy server to send your usage data by selecting the
    Proxy
    checkbox, and then completing the following fields:
    The green checkbox icons that display to the right of the proxy settings indicate that
    Layer7 Live API Creator
    successfully connected to the proxy server.
    Proxy URL
    The endpoint URL of the proxy server.
    Proxy Port
    The destination port of the proxy server.
    Proxy Username
    The authentication username for the proxy server. This field is required only if the proxy server requires the username to connect to it.
    Proxy Password
    The authentication password for the proxy server. This field is required only if the proxy server requires the password to connect to it.
    Layer7 Live API Creator
    encrypts the password that is creates in the
    telemetry.JSON
    file.
  6. Click
    Submit
    .
    Layer7 Live API Creator
    saves these settings to the
    telemetry.JSON
    file. The dialog that your activation has been successful appears.
    Layer7 Live API Creator
    is active and (if you have consented to
    Layer7 Live API Creator
    collecting and sending usage data) it is configured to collect and send usage data. The EULA displays.
  7. Click
    Ok
    .
    The API Creator logon authentication dialog opens.
  8. Log in to API Creator.
You have activated
Layer7 Live API Creator
under a standard license.
Configure External Logging
You can create a logger for externalizing your usage data logs and then use it to verify that you have configured
Layer7 Live API Creator
to collect and send usage data. Include a logger entry for the
lactelemetrylogger
logger in the logging configuration file that you create. The logger uses this entry to capture the activities for sending usage data to an external logger.
For more information about how to configure external logging, see External Logging.
Update your Usage Data Configuration
You can update your usage data configuration, such as setting the license type for your installation, using one of the following methods:
  • During the DevOps process, by changing the
    telemetry.json
    file.
  • By adding options to the Java command line for your server when you start API Server.
    For example, to change the license type for your
    Layer7 Live API Creator
    installation from a standard license to a PLA, add the following option at API Server startup:
    -DLAC_TELEMETRY_PLA_ENABLED=true
This procedure details how to update your usage data configuration by changing the
telemetry.json
file.
For more information about how to add options at API Server startup, see API Server Startup Options.
Follow these steps:
  1. Stop API Server.
  2. Open the
    telemetry.json
    file, update the value for the attribute, and then save your changes.
    For more information about the attributes that you can update, see the "The Usage Data that Live API Creator Collects and Sends" section.
  3. Start API Server.
Your usage data configuration is updated.
Change the Password for the Proxy Server
You can change the password for the proxy server using one of the following methods:
  • During the DevOps process, by changing the
    telemet
    ry.json
    file.
  • At API Server startup, by adding the
    LAC_TELEMETRY_PROXY_PASSWORD
    option.
This procedure details how to change the password by changing the
telemetry.json
file.
For more information about how to add options at API Server startup, see API Server Startup Options.
Follow these steps:
  1. Stop API Server.
  2. Open the
    telemetry.json
    file, add the following attribute and value, and then save your changes:
    "proxy_plain_password": "
    password
    "
  3. Start API Server.
    Layer7 Live API Creator
    replaces the
    proxy_plain_password
    attribute that you added to the
    telemetry.JSON
    file and with the following attribute and value:
    "proxy_encrypted_password": "<encrypted password"
Your password for the proxy is changed.
The Segment Java API
Layer7 Live API Creator
communicates with Segment by way of the Segment Java API. The Segment endpoint is
api.segment.io
, port 443. The Segment API communicates by way of SSL.
For more information about Segment, see the Segment website.