SnapLogic

The SnapLogic connector extracts metadata from the SnapLogic REST API to build lineage for data movement and transformations within SnapLogic pipelines.

The SnapLogic connector extracts pipeline metadata from the SnapLogic REST API to build lineage for data movement and transformations within your SnapLogic environment. It supports both cloud-based extraction and local file-based analysis.

Prerequisites

  • A SnapLogic user with Org Admin rights (required for REST API access)
  • Network access to the SnapLogic Control Plane
  • Bigeye workspace with admin access and a Bigeye API key

Configuration Parameters

Create a properties file (for example, snaplogic.properties) with your connection configuration:

PropertyTypeRequiredDescriptionExample
environment.name.NStringYesEnvironment identifier used to group projectsProd
bigeye.host.NURLYesBigeye instance URLhttps://app.bigeye.com
bigeye.apikey.NStringYesBigeye API keybigeye_pak_abc123
bigeye.allowed.workspaces.NInteger ListYesComma-separated workspace IDs123
snaplogic.control.plane.NStringYesHostname of the SnapLogic Control Planeelastic.snaplogic.com
snaplogic.project.path.NStringYesPath to the SnapLogic projectPartners/Acme
snaplogic.hours.NIntegerNoHours of pipeline execution history to analyze (counting backward from now)24
snaplogic.username.NStringYesService account username for the REST API[email protected]
snaplogic.password.NStringYesService account password
snaplogic.load.from.cloud.NBooleanNoRead projects from SnapLogic cloud. Set to No to use local pipeline files insteadYes
snaplogic.pipeline.location.NPathIf not cloudPath to local SnapLogic pipeline files/data/snaplogic/pipelines/

📝 Note For UAT or EMEA environments, substitute the control plane hostname accordingly (for example, uat.snaplogic.com or emea.snaplogic.com).

Sample Properties File

environment.name.1=SnapLogic Production
bigeye.host.1=https://app.bigeye.com
bigeye.apikey.1=bigeye_pak_acbdefg123456
bigeye.allowed.workspaces.1=123
snaplogic.control.plane.1=elastic.snaplogic.com
snaplogic.project.path.1=Partners/Acme
snaplogic.hours.1=24
[email protected]
snaplogic.password.1=${SNAPLOGIC_PASSWORD}
snaplogic.load.from.cloud.1=Yes

Running the Connector

With the Agent CLI (recommended)

# Install and configure the Lineage Plus agent
./bigeye-agent install

# Add the SnapLogic connector
./bigeye-agent add-connector -c snaplogic

# Run the connector
./bigeye-agent lineage run -c snaplogic

With Docker

docker run --rm \
  -v /path/to/config:/app/config \
  --entrypoint bash bigeyedata/source-connector:latest \
  -c "bigeye-connector run -c snaplogic -p /app/config/snaplogic.properties"