Quick Start

If you are familiar with the BIG-IP system, and generally familiar with REST and using APIs, this section contains the minimum amount of information to get you up and running with Telemetry Streaming.

  1. Download the latest RPM package from F5 Telemetry Streaming site on GitHub in the dist directory.
  2. Upload and install the RPM package on the using the BIG-IP GUI:
  3. Be sure to see the known issues on GitHub (https://github.com/F5Networks/f5-telemetry-streaming/issues) to review any known issues and other important information before you attempt to use Telemetry Streaming.
  4. Provide authorization (basic auth) to the BIG-IP system:
  5. Using a RESTful API client like Postman, GET an open and closed bracket ({}) to the URI https://{{host}}/mgmt/shared/telemetry/info to ensure Telemetry Streaming is running properly.
  6. Copy one of the Example Declarations which best matches the configuration you want to use. Alternatively, you can use the simple “Hello World” example below, which is a good start if you don’t have an example in mind.
  7. Paste the declaration into your API client, and modify names and IP addresses as applicable.
  8. POST to the URI https://<BIG-IP>/mgmt/shared/telemetry/declare

Quick Start Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 {
     "class": "Telemetry",
     "controls": {
         "class": "Controls",
         "logLevel": "info"
     },
     "My_Poller": {
         "class": "Telemetry_System_Poller",
         "interval": 60
     },
     "My_Listener": {
         "class": "Telemetry_Listener",
         "port": 6514
     },
     "My_Consumer": {
         "class": "Telemetry_Consumer",
         "type": "Splunk",
         "host": "192.0.2.1",
         "protocol": "https",
         "port": "8088",
         "passphrase": {
             "cipherText": "apikey"
         }
     }
 }