Brooklin Configuration

Overview

• The listing below documents all configuration properties of the Brooklin server application. However, it does not capture properties specific to certain Connectors or TransportProviders. These can be found on the individual wiki pages of the respective modules.

• These properties are typically provided to Brooklin through a Java properties file. An example is located at https://github.com/linkedin/brooklin/blob/master/config/server.properties.

Config Properties

brooklin.server.connector.<connectorName>.factoryClassName

• Required
• Fully-qualified Connector factory class name
• Factory class must implement the ConnectorFactory interface.
• <connectorName> must match one of the names specified in brooklin.server.connectorNames
• One such property is required for every Connector name specified in brooklin.server.connectorNames
• Please refer to individual Connector wiki pages for specific config properties

brooklin.server.connectorNames

• Required
• A comma-separated list of Connector names
• Connector names can be arbitrary strings
• Connector names are used to identify them in configuration options and Datastream operations
• At least one Connector name must be provided

brooklin.server.coordinator.cluster

• Required
• Brooklin cluster name
• Also the name of the top-level znode for a Brooklin cluster in ZooKeeper

brooklin.server.coordinator.zkAddress

• Required
• ZooKeeper URL
• Address of ZooKeeper instance to use for maintaining metadata about Coordinators, Datastreams, and DatastreamTasks

brooklin.server.csvMetricsDir

• Optional
• Metrics reports directory
• Directory where CSV metrics reports are generated

brooklin.server.diag.path

• Optional
• Datastream Management Service (DMS) health-monitoring REST endpoint path
• Default is empty string

brooklin.server.diag.port

• Optional
• Datastream Management Service (DMS) health-monitoring REST endpoint port
• Default is brooklin.server.httpPort

brooklin.server.httpPort

• Optional
• Datastream Management Service (DMS) port
• This is the port used by the HttpJettyServer of the DMS service
• Specifying 0 causes a port to be selected at random (default)

brooklin.server.serde.<serdeName>.factoryClassName

• Fully-qualified SerDe factory class name
• Factory class must implement the SerdeAdminFactory interface
• Not required unless brooklin.server.serdeNames is non-empty
• <serdeName> must match one of the names specified in brooklin.server.serdeNames
• One such property is required for every SerDe name specified in brooklin.server.serdeNames

brooklin.server.serdeNames

• Optional
• A comma-separated list of SerDe (Serializer/Deserializer) names
• SerDe names can be arbitrary strings
• SerDe names are used to identify them in configuration options and Datastream operations

brooklin.server.transportProvider.<transportProviderName>.factoryClassName

• Required
• Fully-qualified TransportProvider factory class name
• Factory class must implement the TransportProviderAdminFactory interface
• <transportProviderName> must match one of the names specified in brooklin.server.transportProviderNames
• One such property is required for every Connector name specified in brooklin.server.transportProviderNames
• Please refer to individual TransportProvider wiki pages for specific config properties

brooklin.server.transportProviderNames

• Required
• A comma-separated list of TransportProvider names
• TransportProvider names can be arbitrary strings
• TransportProvider names are used to identify them in configuration options and Datastream operations
• At least one TransportProvider name must be provided