Services configuration
Spider services default configuration may be overridden in the values.yaml
file using the extraConfiguration
field.
Any configuration keys and values put there will be merge to the configuration file of the service, and taken into account (if legit).
For more accessibility, the services configuration have been grouped in functional goal in the table below.
List of services
Group | Services | Description |
---|---|---|
Configuration | config | Service exposing other services configuration as well as Spider licence. |
ciphers | Gociphers management service: creation, configuration, security keys... | |
controls | Controllers management service: creation, configuration, security keys, attachments... | |
customer | Customer management service: creation, connection, password... | |
teams | Teams management service: creation, settings, token... | |
whisp | Whisperers/Gossipers management service: creation, configuration, security keys... | |
Packets management | packWrite | Service saving captured network packets from Whisperers. |
packRead | Service exposing captured network packets. | |
packUpdate | Service to update / remove captured network packets once analyzed. | |
packPoller | Service polling packets from Redis to save them in Elasticsearch. | |
Tcp sessions management | tcpWrite | Service saving captured TCP sessions from Whisperers. |
tcpRead | Service exposing captured TCP sessions. | |
tcpUpdate | Service to get TCP sessions to parse, and to update them. | |
tcpPoller | Service polling TCP sessions from Redis to save them in Elasticsearch. | |
Tls keys management | tlsKeys | Service saving captured TLS sessions from Gociphers. |
tlsKeysLinker | Service that links TLS keys and TCP sessions together. | |
Hosts management | hosts | Service to management hosts detected while capturing. |
hostsAggs | Poller aggregating replicates of the same host. | |
hostsPoller | Service polling Hosts from Redis to save them in Elasticsearch. | |
Http parsing | webWrite | Service to rebuild and analyze HTTP communications. |
webRead | Service to access analyzed HTTP communications. | |
webUpload | Service to upload HTTP communications (in JSON) from the UI. | |
webHttpComPoller | Service polling HTTP communications metadata from Redis to save them in Elasticsearch. | |
webHttpComContentPoller | Service polling HTTP communications content from Redis to save them in Elasticsearch. | |
webHttpPersPoller | Service polling HTTP parsing logs from Redis to save them in Elasticsearch. | |
UIs | login | Service exposing the web application for: user connection, user creation and password reset. |
networkView | Service exposing the main Web application to manage Spider and analyze communications. | |
selfMonitoring | Service exposing the Web application to access Spider monitoring data and troubleshoot issues. | |
UI utils | guiSettings | Service to manage User UI settings. |
jobs | Service to manage asynchronous jobs of upload and purge. | |
links | Service to manage sharing links. | |
plugins | Service to manage UI plugins. | |
Run | mailSender | Service to send notifications mails. |
maintenance | Service to optimize Elasticsearch indices, to purge old deleted users (RGPD) and to backup configuration data. | |
statsCollector | Service collecting usage statistics to send to Floocus main servers. | |
Monitoring | alert | Service performing requests to monitoring data and sends mails on anomaly detection. |
captureStatusPoller | Service polling aggregated Whisperer capture status from Redis to save them in Elasticsearch. | |
ciphersRawStatusPoller | Service polling raw Gociphers status from Redis to save them in Elasticsearch. | |
ciphersStatus | Service managing Gociphers status. | |
ciphersStatusAgg | Poller aggregating status of all Gociphers replicates. | |
ciphersStatusPoller | Service polling last Gociphers status from Redis to save them in Elasticsearch. | |
guiLogs | Service managing logs emitted by Web applications. | |
monitorRead | Service exposing monitoring data. | |
monitorWrite | Service capturing monitoring data. | |
parsingStatusHttpPersPoller | Service polling HTTP parsing status from Redis to save them in Elasticsearch. | |
parsingStatusTcpSessionPoller | Service polling TCP parsing status from Redis to save them in Elasticsearch. | |
sessions | Service to store users sessions statistics on Web applications. | |
statusPoller | Service polling raw Whisperers status from Redis to save them in Elasticsearch. | |
whispStatusPoller | Service polling last Whisperer status from Redis to save them in Elasticsearch. | |
whispsStatus | Service managing Whisperers status. | |
whispsStatusAgg | Poller aggregating status of all Whisperers replicates. |
Common configuration
The following configuration is common to all services (by default) but may be customized for each once of them.
serverPort: 3000
stats:
interval: PT20S
bucketSpan: PT5S
bucketCount: 5
confRefreshDelay: PT120S
downstreamCb:
circuitDuration: PT10S
circuitThreshold: 0.95
shutdownDelay: PT1S
useWhispererRoutingWithES: false