MonitorExporterTransfers (Waarp All 3.6.2-jre8 API Reference)

java.lang.Object
- java.lang.Thread
- - org.waarp.openr66.protocol.monitoring.MonitorExporterTransfers

All Implemented Interfaces:: Closeable, AutoCloseable, Runnable

public class MonitorExporterTransfers
extends Thread
implements Closeable

The Monitor exports Transfers into a Json Format to a remote API REST or an Elasticsearch server (if JRE >= 8) in order to allow to monitor multiple Waarp Servers from one central monitoring, such as using Elasticsearch with Kibana/Grafana through RESP API from Logstash engine or equivalent, or your own REST API server or a Elasticsearch server.

Json format is:


  {
    "results": [                            # Array of Transfer information
      {
        "specialId": 12345,                     # Id as Long (-2^63 to 2^63 - 1)
        "uniqueId": "owner.requester.requested.specialId", # Unique global Id
        "hostId": "R66Owner",                   # R66 Owner (Server name)
        "globalStep": "step",                   # Global Current Step
        "globalLastStep": "laststep",           # Global Last Step previous Current
        "step": 1,                              # Current Step in Global Current Step
        "rank": 123,                            # Current Rank in transfer step
        "status": "status",                     # Current status
        "stepStatus": "stepstatus",             # Status of previous Step
        "originalFilename": "originalFilename", # Original Filename
        "originalSize": 123456,                 # Original file size
        "filename": "filename",                 # Resolved local filename
        "ruleName": "ruleName",                 # Rule name
        "blockSize": 123,                       # Block size during transfer
        "fileInfo": "fileInfo",                 # File information, containing associated file transfer information
        "followId": 123456,                     # Follow Id as Long (-2^63 to 2^63 - 1)
        "transferInfo": "transferInfo as Json", # Transfer internal information as Json String
        "start": "2021-03-28T11:55:15Z",        # Start date time of the transfer operation
        "stop": "2021-03-28T11:58:32Z",         # Current last date time event of the transfer operation
        "requested": "requested",               # Requested R66 hostname
        "requester": "requester",               # Requester R66 hostname
        "retrieve": true,                       # True if the request is a Pull, False if it is a Push
        "errorCode": "errorCode",               # Code of error as one char
        "errorMessage": "errorMessage",         # String message of current Error
        "waarpMonitor": {                       # Extra information for indexing if necessary
          "from": "2021-03-28T11:58:15Z",       # filter from (could be empty if none)
          "to": "2021-03-28T11:59:15Z",         # filter to
          "index": "r66owner"                   # R66 Hostname lowercase
        }
      },
      ...
    ]
  }

And the header of the HTTP request will contain:
X-WAARP-ID (as the host Id), X-WAARP-START (as the waarpMonitor.from), X-WAARP-STOP (as the waarpMonitor.to)

Nested Class Summary
- Nested classes/interfaces inherited from class java.lang.Thread
  Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`FOLLOW_ID`
`static String`	`FROM_DATE_TIME`
`static String`	`HEADER_WAARP_ID`
`static String`	`HEADER_WAARP_START`
`static String`	`HEADER_WAARP_STOP`
`static String`	`HOST_ID`
`static String`	`INDEX_NAME`
`static boolean`	`MONITOR_INTERVAL_INCLUDED_DEFAULT`
`static boolean`	`MONITOR_KEEP_CONNECTION_DEFAULT`
`static boolean`	`MONITOR_LONG_AS_STRING_DEFAULT`
`static String`	`ORIGINAL_SIZE`
`static String`	`RESULTS`
`static String`	`SPECIAL_ID`
`static String`	`TO_DATE_TIME`
`static String`	`UNIQUE_ID`
`static String`	`WAARP_MONITOR`

Fields inherited from class java.lang.Thread
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors
Constructor and Description
`MonitorExporterTransfers(String remoteBaseUrl, String endpoint, String basicAuthent, String token, String apiKey, boolean keepConnection, boolean intervalMonitoringIncluded, boolean transformLongAsString, io.netty.channel.EventLoopGroup group)` Note that only one among (basicAuthent, token, apikey) is allowed and will be taken into account.
`MonitorExporterTransfers(String remoteBaseUrl, String prefix, String index, String username, String pwd, String token, String apiKey, boolean intervalMonitoringIncluded, boolean transformLongAsString, boolean compression)` The index can be a combination of a fixed name and extra dynamic information: %%WAARPHOST%% to be replaced by R66 host name %%DATETIME%% to be replaced by date in format YYYY.MM.dd.HH.mm %%DATEHOUR%% to be replaced by date in format YYYY.MM.dd.HH %%DATE%% to be replaced by date in format YYYY.MM.dd %%YEARMONTH%% to be replaced by date in format YYYY.MM %%YEAR%% to be replaced by date in format YYYY DATE is about current last-time check.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

void close()

void run()
- Methods inherited from class java.lang.Thread
  activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
- Methods inherited from class java.lang.Object
  equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`void`	`run()`

- Field Detail
  - MONITOR_KEEP_CONNECTION_DEFAULT
```
public static final boolean MONITOR_KEEP_CONNECTION_DEFAULT
```
    See Also:
    
    Constant Field Values
  - MONITOR_INTERVAL_INCLUDED_DEFAULT
```
public static final boolean MONITOR_INTERVAL_INCLUDED_DEFAULT
```
    See Also:
    
    Constant Field Values
  - MONITOR_LONG_AS_STRING_DEFAULT
```
public static final boolean MONITOR_LONG_AS_STRING_DEFAULT
```
    See Also:
    
    Constant Field Values
  - HEADER_WAARP_ID
```
public static final String HEADER_WAARP_ID
```
    See Also:
    
    Constant Field Values
  - HEADER_WAARP_START
```
public static final String HEADER_WAARP_START
```
    See Also:
    
    Constant Field Values
  - HEADER_WAARP_STOP
```
public static final String HEADER_WAARP_STOP
```
    See Also:
    
    Constant Field Values
  - SPECIAL_ID
```
public static final String SPECIAL_ID
```
    See Also:
    
    Constant Field Values
  - FOLLOW_ID
```
public static final String FOLLOW_ID
```
    See Also:
    
    Constant Field Values
  - UNIQUE_ID
```
public static final String UNIQUE_ID
```
    See Also:
    
    Constant Field Values
  - HOST_ID
```
public static final String HOST_ID
```
    See Also:
    
    Constant Field Values
  - ORIGINAL_SIZE
```
public static final String ORIGINAL_SIZE
```
    See Also:
    
    Constant Field Values
  - RESULTS
```
public static final String RESULTS
```
    See Also:
    
    Constant Field Values
  - WAARP_MONITOR
```
public static final String WAARP_MONITOR
```
    See Also:
    
    Constant Field Values
  - FROM_DATE_TIME
```
public static final String FROM_DATE_TIME
```
    See Also:
    
    Constant Field Values
  - TO_DATE_TIME
```
public static final String TO_DATE_TIME
```
    See Also:
    
    Constant Field Values
  - INDEX_NAME
```
public static final String INDEX_NAME
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MonitorExporterTransfers
```
public MonitorExporterTransfers(String remoteBaseUrl,
                                String endpoint,
                                String basicAuthent,
                                String token,
                                String apiKey,
                                boolean keepConnection,
                                boolean intervalMonitoringIncluded,
                                boolean transformLongAsString,
                                io.netty.channel.EventLoopGroup group)
```
    Note that only one among (basicAuthent, token, apikey) is allowed and will be taken into account.
    
    Parameters:
    
    remoteBaseUrl - as 'http://myhost.com:8080' or 'https://myhost.com:8443'
    
    endpoint - as '/waarpr66monitor' or simply '/'
    
    basicAuthent - Basic Authent in Base64 format to connect to REST API if any (Basic authentication from 'username:paswwd') (nullable)
    
    token - access token (Bearer Token authorization by Header) (nullable)
    
    apiKey - API Key (Base64 of 'apiId:apiKey') (ApiKey authorization by Header) (nullable)
    
    keepConnection - True to keep the connexion opened, False to release the connexion each time
    
    intervalMonitoringIncluded - True to include the interval information within 'waarpMonitor' field
    
    transformLongAsString - True to transform Long as String (ELK)
    
    group - the EventLoopGroup to use for HttpMonitoringExporterClient
    
    Throws:
    
    IllegalArgumentException - if the setup is in error
  - MonitorExporterTransfers
```
public MonitorExporterTransfers(String remoteBaseUrl,
                                String prefix,
                                String index,
                                String username,
                                String pwd,
                                String token,
                                String apiKey,
                                boolean intervalMonitoringIncluded,
                                boolean transformLongAsString,
                                boolean compression)
```
    The index can be a combination of a fixed name and extra dynamic information:
    - %%WAARPHOST%% to be replaced by R66 host name
    - %%DATETIME%% to be replaced by date in format YYYY.MM.dd.HH.mm
    - %%DATEHOUR%% to be replaced by date in format YYYY.MM.dd.HH
    - %%DATE%% to be replaced by date in format YYYY.MM.dd
    - %%YEARMONTH%% to be replaced by date in format YYYY.MM
    - %%YEAR%% to be replaced by date in format YYYY
    DATE is about current last-time check.
    So 'waarpr66-%%WAARPHOST%%-%%DATE%%' will give for instance 'waarpr66-hosta-2021-06-21' as index name.
    Note that only one among (username/pwd, token, apikey) is allowed and will be taken into account.
    Parameters:
    
    remoteBaseUrl - as 'http://myelastic.com:9200' or 'https://myelastic.com:9201'
    
    prefix - as '/prefix' or null if none
    
    index - as 'waarpr66monitor' as the index name within Elasticsearch, including extra dynamic information
    
    username - username to connect to Elasticsearch if any (Basic authentication) (nullable)
    
    pwd - password to connect to Elasticsearch if any (Basic authentication) (nullable)
    
    token - access token (Bearer Token authorization by Header) (nullable)
    
    apiKey - API Key (Base64 of 'apiId:apiKey') (ApiKey authorization by Header) (nullable)
    
    intervalMonitoringIncluded - True to include the interval information within 'waarpMonitor' field
    
    transformLongAsString - True to transform Long as String (ELK)
    
    compression - True to compress REST exchanges between the client and the Elasticsearch server
    
    Throws:
    
    IllegalArgumentException - if the setup is in error
- Method Detail
  - run
```
public void run()
```
    Specified by:
    
    run in interface Runnable
    
    Overrides:
    
    run in class Thread
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException

Class MonitorExporterTransfers

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Field Summary

Fields inherited from class java.lang.Thread

Constructor Summary

Method Summary

Methods inherited from class java.lang.Thread

Methods inherited from class java.lang.Object

Field Detail

MONITOR_KEEP_CONNECTION_DEFAULT

MONITOR_INTERVAL_INCLUDED_DEFAULT

MONITOR_LONG_AS_STRING_DEFAULT

HEADER_WAARP_ID

HEADER_WAARP_START

HEADER_WAARP_STOP

SPECIAL_ID

FOLLOW_ID

UNIQUE_ID

HOST_ID

ORIGINAL_SIZE

RESULTS

WAARP_MONITOR

FROM_DATE_TIME

TO_DATE_TIME

INDEX_NAME

Constructor Detail

MonitorExporterTransfers

MonitorExporterTransfers

Method Detail

run

close