Automatic Transmission of Usage Data

In v39 and later, on-premises instances connected to the internet automatically send usage data to Hyperscience daily. Learn more about the usage export in Usage Bundle.

To learn more about what this export contains, see the Usage Bundle Metrics article in the user guide for your version of Hyperscience. In v41 and earlier, this article is called Usage Report.

Automatic transmission is enabled by default. You cannot change its schedule or its contents.

Instances not connected to the internet

If your instance is not connected to the internet, disable automatic transmission by adding the following to your .envfile:

HS_AUTOMATED_USAGE_AND_SETTINGS_TRANSMISSION_ENABLED=false

Automatic transmission is the default method for sending usage data to Hyperscience. If you disable it, you need to send your usage data by an alternate method that your Hyperscience representative has reviewed and agreed to.

Instances connected to the internet

Depending on your organization's security measures, you may need to configure a proxy, allow outbound requests through your firewall, or add certificates to a custom CA bundle.

Configure a proxy

Your IT team may determine that a proxy is needed to transmit usage data. If you have already configured a proxy for Hyperscience by following the steps in Proxy Server, that configuration is used. If a different proxy is required, set the.envvariables that apply to your organization's security policies:

Variable	Value
`HS_AUTOMATED_USAGE_AND_SETTINGS_TRANSMISSION_PROXY_HTTP`	An address in the form `proto://host:port`.
`HS_AUTOMATED_USAGE_AND_SETTINGS_TRANSMISSION_PROXY_HTTPS`	An address in the form `proto://host:port`. When this is not set, the HTTP proxy address is used for HTTPS as well.
`HS_AUTOMATED_USAGE_AND_SETTINGS_TRANSMISSION_PROXY_CERTIFICATE_PATH`	The path to the client certificate.
`HS_AUTOMATED_USAGE_AND_SETTINGS_TRANSMISSION_PROXY_KEY_PATH`	The path to the client key. Set this only when the certificate and key are in separate files.

Proxy values are redacted from the usage data before it is sent.

Configure a firewall for outbound requests

If your IT team has configured a firewall that prevents the system from issuing outbound requests, work with them to allow requests to https://usage-reporting.hyperscience.net.

Configure a custom CA bundle

If your instance validates outbound connections against a custom CA bundle, that bundle needs to include the root certificates used by the usage data endpoint. Otherwise, the daily transmission fails certificate validation.

A custom CA bundle replaces the default set of trusted root certificates. When you set the HS_TLS_CA_BUNDLE .env variable, the application no longer trusts any root certificate that is not in your bundle. To learn more, see HS_TLS_CA_BUNDLE in Security.

The certificate presented by the usage data endpoint chains to a root operated by Amazon Trust Services. Amazon Trust Services recommends including all of its roots in a custom trust store, because the root that a given endpoint chains to can change.

To add the Amazon root certificates to your bundle:

Go to the Amazon Trust Services Repository page. In the Certification authorities section, download the PEM version of each root CA certificate.
Copy the downloaded files to the certs directory used by your deployment — for example, /mnt/hs/certs.

Append the certificates to the bundle file named by HS_TLS_CA_BUNDLE:

cd $HS_PATH/certs
cat AmazonRootCA1.pem AmazonRootCA2.pem AmazonRootCA3.pem AmazonRootCA4.pem SFSRootCAG2.pem >> <CA_bundle_filename>

Give the application read access to the bundle:
```
chmod 644 $HS_PATH/certs/*
```
If SELinux is enabled, restore the file context:
```
chcon -t container_file_t -R $HS_PATH/certs/
```

Troubleshooting

In v43.1 and later, the Usage page in the application reports the status of each transmission, which is the fastest way to tell whether a configuration change has taken effect. To learn more, see the Usage Bundle article for your version of Hyperscience.