piserver.yml configuration file

This page outlines the settings available in the IPLM Server configuration file /etc/mdx/piserver.yml. 

For log rotation, see IPLM Server logging.

Common section

maxQueuedRequests

1024

idleThreadTimeout

1 minute

shutdownGracePeriod

30 seconds

gzip sub section

enabled

true

minimumEntitySize

256 bytes

bufferSize

8 KiB

Application section

minThreads

8

maxThreads

1024

ApplicationConnectors section

bindHost

HOST

port

8080

acceptorThreads

selectorThreads

Neo4j credentials section

databaseName

None

httpClient section

maxconnections

maxConnectionsPerRoute

timeout

connectionTimeout

connectionRequestTimeout

timeToLive

keepAlive

validateAfterInactivityPeriod

retries

userAgent

gzipEnabled

gzipEnabledForRequests

chunkedEncodingEnabled

Security section

accessTokenExpirationTime

0

Time an access token can be idle before it is invalidated. If set to 0, access tokens never expire.

geofencing

false

logUsername

false

passwordValidationPattern

none

passwordValidationDescription

none

External security subsection

script

SCRIPT

External authentication script

scriptTimeout

External synchronization subsection

script

SCRIPT

scriptTimeout

Helix authentication service

name

statusUrl

Redis section

hosts

"demo2:6379"

Redis hosts.

sentinelMaster

MASTER

Redis Sentinel master.

timeout

2 seconds

Redis timeout.

Prometheus metrics section

enabled

false

Whether or not to enable the Prometheus exporter server

port

2002

Port of the Prometheus exporter server

Validation section

API section

Janitor section

IPLM Server logging levels

The logging output becomes more verbose with each option.

• WARN logs warning messages.

• INFO logs info messages.

• DEBUG logs messages helpful for debugging.

piserver.yml example

# --------------------------------------------------
# Pi Server configuration
# --------------------------------------------------

# --------------------------------------------------
# IMPORTANT:
# This file was migrated from a legacy configuration file
# This notice should be removed when this file is modified manually
# --------------------------------------------------


# --------------------------------------------------
# Server
# --------------------------------------------------
server:
    # --------------------------------------------------
    # Common
    # --------------------------------------------------
    # The maximum number of requests to queue before blocking the acceptors
    maxQueuedRequests: 1024
    # The amount of time a worker thread can be idle before being stopped
    idleThreadTimeout: 1 minute
    # The maximum time to wait for the server to cleanly shutdown before forcibly terminating it
    shutdownGracePeriod: 30 seconds
    gzip:
        # If true:
        # - requests with 'gzip' in the 'Accept-Encoding' header will have their response entities compressed
        # - requests with 'gzip' in the 'Content-Encoding' header will have their request entities decompressed
        enabled: true
        # Response entities under this size are not compressed
        minimumEntitySize: 256 bytes
        # The size of the buffer to use when compressing
        bufferSize: 8 KiB
    # --------------------------------------------------
    # Application
    # --------------------------------------------------
    # The minimum number of threads to keep alive in the thread pool
    minThreads: 8
    # The maximum number of threads the thread pool is allowed to grow
    maxThreads: 1024
    applicationConnectors:
        - type: http
          # The hostname to bind to
          #bindHost: HOST
          # The TCP/IP port on which to listen for incoming connections
          port: 8080
          # The number of worker threads dedicated to accepting connections
          #acceptorThreads: N
          # The number of worker threads dedicated to sending and receiving data
          #selectorThreads: N
          # The size of the TCP/IP accept queue for the listening socket
          #acceptQueueSize: N
          # The size of the header field cache
          #headerCacheSize: 512 bytes
          # The size of the buffer into which response content is aggregated before being sent to the client
          #outputBufferSize: 32 KiB
          # The maximum size of a request header
          #maxRequestHeaderSize: 8 KiB
          # The maximum size of a response header
          #maxResponseHeaderSize: 8 KiB
          # The size of the per-connection input buffer
          #inputBufferSize: 8 KiB
          # The maximum idle time for a connection
          #idleTimeout: 30 seconds
          # The minimum size of the buffer pool
          #minBufferPoolSize: 64 bytes
          # The maximum size of the buffer pool
          #maxBufferPoolSize: 64 KiB
          # The increment by which the buffer pool should be increased
          #bufferPoolIncrement: 1 KiB
          # Whether or not SO_REUSEADDR is enabled on the listening socket
          #reuseAddress: true
          # Whether or not to add the 'Server' header to each response
          #useServerHeader: false
          # Whether or not to add the 'Date' header to each response
          #useDateHeader: true
    # --------------------------------------------------
    # Admin
    # --------------------------------------------------
    adminMinThreads: 1
    adminMaxThreads: 64
    adminConnectors:
        - type: http
          port: 8081

# --------------------------------------------------
# Neo4j
# --------------------------------------------------
neo4j:
    # URI of the Neo4j server/proxy
    uri: "http://localhost:7474/pi"    # Neo4j credentials
    #username: USERNAME
    #password: PASSWORD
    httpClient:
        # The maximum number of concurrent open connections
        #maxConnections: 1024
        # The maximum number of concurrent open connections per route
        #maxConnectionsPerRoute: 1024
        # The maximum idle time for a connection, once established
        #timeout: 500 ms
        # The maximum time to wait for a connection to open
        #connectionTimeout: 500 ms
        # The maximum time to wait for a connection to be returned from the connection pool
        #connectionRequestTimeout: 500 ms
        # The maximum time a pooled connection can stay idle (not leased to any thread) before it is shut down
        #timeToLive: 1 hour
        # The maximum time a connection will be kept alive before it is reconnected
        # If set to 0, connections will be immediately closed after every request/response
        #keepAlive: 0 ms
        # The maximum time before a persistent connection is checked to remain active
        # If set to 0, no inactivity check will be performed
        #validateAfterInactivityPeriod: 0 ms
        # The number of times to retry failed requests
        #retries: 0
        # The 'User-Agent' header to send with requests
        #userAgent: AGENT
        # If true:
        # - adds an 'Accept-Encoding: gzip' header to all requests
        # - enables automatic gzip decoding of responses
        #gzipEnabled: true
        # If true:
        # - adds a 'Content-Encoding: gzip' header to all requests
        # - enables automatic gzip encoding of requests
        #gzipEnabledForRequests: true
        # Enables the use of chunked encoding for requests
        #chunkedEncodingEnabled: true

# --------------------------------------------------
# Security
# --------------------------------------------------
security:
    # Time an access token can be idle before it is invalidated
    # If set to 0, access tokens never expire
    accessTokenExpirationTime: 0 seconds
externalSecurity:
    # External authentication script
    #script: SCRIPT
    # External authentication script timeout
    scriptTimeout: 10 seconds
externalSync:
    # External synchronization script
    #script: SCRIPT
    # External synchronization script timeout
    scriptTimeout: 30 seconds
helixAuthenticationService:
	# name: myName 
	# statusUrl: https://authen.doc
	# executionTimeout: 30 seconds
	# userIdentifier: nameID

# --------------------------------------------------
# Redis (events)
# --------------------------------------------------
redis:
    # Redis hosts
    hosts: "demo2:6379"    # Redis Sentinel master
    #sentinelMaster: MASTER
    # Redis timeout
    timeout: 2 seconds

# --------------------------------------------------
# Prometheus metrics
# --------------------------------------------------

prometheus:
    # Whether or not to enable the Prometheus exporter server
    enabled: true
    # Port of the Prometheus exporter server
    port: 2002

# --------------------------------------------------
# Access log
# --------------------------------------------------
accessLogFile: "/var/log/mdx-piserver/piserver-access.log"
# --------------------------------------------------
# Logging
# --------------------------------------------------
logging:
    level: INFO
    appenders:
        - type: file
          currentLogFilename: /var/log/mdx-piserver/piserver.log    
          archive: true    
          archivedLogFilenamePattern: /var/log/mdx-piserver/piserver-%d.log    
          archivedFileCount: 5

# ------------------------------------------------------------------------------
# Validation
# ------------------------------------------------------------------------------

#validation:
    # If true, the P4 repo paths of IPVs on different lines must not overlap (if they have the same host)
	#checkP4RepoPathOverlap: true

	# ------------------------------------------------------------------------------
	# Hook
	# ------------------------------------------------------------------------------

	#hook:
		# The absolute location of the hook file (must be executable)
		#file: FILE
		# The charset used by the input of the hook
		#inputCharset: UTF-8
		# The charset used by the output of the hook
		#outputCharset: UTF-8
		# The hook execution timeout
		#executionTimeout: 5 seconds
		# The hook lock acquisition timeout
		#lockAcquisitionTimeout: 3 seconds
	# ------------------------------------------------------------------------------
	# API
	# ------------------------------------------------------------------------------       
	#api:
               #publicPaginationPageSize: 10000
               #cliPaginationPageSize: 10000
               #cliPaginationConcurrentRequests: 5
               #prettyJson: true
       # ------------------------------------------------------------------------------
       # Janitor
	# ------------------------------------------------------------------------------       
	#janitor:
		#initialDelay: 60
		#fileListCompressorThreads: 1 - NO LONGER NEEDED
		#fileListCompressorBatchSize: 50000 - NO LONGER NEEDED
		#fileListCompressionPeriod: 3600 seconds - NO LONGER NEEDED
		#licensingCheckPeriod: 20 seconds
       # ------------------------------------------------------------------------------
	# neo4jdriver
	# ------------------------------------------------------------------------------       
	#neo4jdriver
		#maxTransactionRetryTime: 30 seconds