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

Commit 5151f23

Browse files
committed
Reformat the profiler client README
1 parent adbdd9e commit 5151f23

File tree

1 file changed

+20
-20
lines changed
  • metron-analytics/metron-profiler-client

1 file changed

+20
-20
lines changed

metron-analytics/metron-profiler-client/README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -41,22 +41,7 @@ Retrieve all values of 'snort-alerts' from '10.0.0.1' that occurred on 'weekdays
4141
PROFILE_GET('snort-alerts', '10.0.0.1', 1, 'MONTHS', 'weekdays')
4242
```
4343

44-
### Configuration
45-
46-
By default, the Profiler creates Profiles with a period duration of 15 minutes. This means that data is accumulated, summarized and flushed every 15 minutes. The Client API must also have knowledge of this duration to correctly retrieve the profile data. If the client API is expecting 15 minute periods, it will not be able to read data generated by a Profiler that has been configured with a 1 hour period.
47-
48-
The period duration can be configured in the Profiler by altering the Profiler topology's static properties file (`$METRON/config/profiler.properties`). The Stellar Client API can be configured by setting the following properties in Metron's global configuration.
49-
50-
| Key | Description | Required | Default |
51-
| ------------------------------------- | -------- | -------- | -------- |
52-
| profiler.client.period.duration | The duration of each profile period. This value should be defined along with `profiler.client.period.duration.units`. | Optional | 15 |
53-
| profiler.client.period.duration.units | The units used to specify the profile period duration. This value should be defined along with `profiler.client.period.duration`. | Optional | MINUTES |
54-
| profiler.client.hbase.table | The name of the HBase table used to store profile data. | Optional | profiler |
55-
| profiler.client.hbase.column.family | The name of the HBase column family used to store profile data. | Optional | P |
56-
| profiler.client.salt.divisor | The salt divisor used to store profile data. | Optional | 1000 |
57-
| hbase.provider.impl | The name of the HBaseTableProvider implementation class. | Optional | |
58-
59-
## Getting Started
44+
### Getting Started
6045

6146
These instructions step through the process of using the Stellar Client API on a live cluster. These instructions assume that the 'Getting Started' instructions included with the [Metron Profiler](../metron-profiler) have been followed. This will create a Profile called 'test' whose data will be retrieved with the Stellar Client API.
6247

@@ -88,9 +73,24 @@ Returns: The profile measurements.
8873

8974
The client API call above has retrieved the past hour of the 'test' profile for the entity '192.168.138.158'.
9075

91-
## Functions
76+
### Configuration
77+
78+
By default, the Profiler creates Profiles with a period duration of 15 minutes. This means that data is accumulated, summarized and flushed every 15 minutes. The Client API must also have knowledge of this duration to correctly retrieve the profile data. If the client API is expecting 15 minute periods, it will not be able to read data generated by a Profiler that has been configured with a 1 hour period.
79+
80+
The period duration can be configured in the Profiler by altering the Profiler topology's static properties file (`$METRON/config/profiler.properties`). The Stellar Client API can be configured by setting the following properties in Metron's global configuration.
81+
82+
| Key | Description | Required | Default |
83+
| ------------------------------------- | -------- | -------- | -------- |
84+
| profiler.client.period.duration | The duration of each profile period. This value should be defined along with `profiler.client.period.duration.units`. | Optional | 15 |
85+
| profiler.client.period.duration.units | The units used to specify the profile period duration. This value should be defined along with `profiler.client.period.duration`. | Optional | MINUTES |
86+
| profiler.client.hbase.table | The name of the HBase table used to store profile data. | Optional | profiler |
87+
| profiler.client.hbase.column.family | The name of the HBase column family used to store profile data. | Optional | P |
88+
| profiler.client.salt.divisor | The salt divisor used to store profile data. | Optional | 1000 |
89+
| hbase.provider.impl | The name of the HBaseTableProvider implementation class. | Optional | |
90+
91+
### Functions
9292

93-
### `PROFILE_GET`
93+
#### `PROFILE_GET`
9494

9595
Retrieves a series of values from a stored profile.
9696

@@ -116,7 +116,7 @@ Retrieve the last 30 minutes of measurements for profile 'profile1' and entity '
116116
PROFILE_GET('profile1', '10.0.0.1', 30, 'MINUTES', 'mondays')
117117
```
118118

119-
### `PROFILE_GET_FROM`
119+
#### `PROFILE_GET_FROM`
120120

121121
Retrieves a series of values from a stored profile.
122122

@@ -134,7 +134,7 @@ Examples
134134

135135
Retrieve the last 30 minutes of measurements for profile 'profile1' and entity '10.0.0.1'. Equivalent to the `PROFILE_GET` example from above.
136136
```
137-
PROFILE_GET_FROM('profile1', 'entity1', MILLIS(30, 'MINUTES')
137+
PROFILE_GET_FROM('profile1', 'entity1', MILLIS(30, 'MINUTES'))
138138
```
139139

140140
Starting from 3 days ago, look back 30 minutes and retrieve the measurements from profile 'profile1' and entity 'entity1'.

0 commit comments

Comments
 (0)