Send Event with Splunk HTTP Event Collector API on New Commit (Instant) from GitLab API

Pipedream makes it easy to connect APIs for Splunk HTTP Event Collector, GitLab and 2,700+ other apps remarkably fast.

Trigger workflow on

New Commit (Instant) from the GitLab API

Next, do this

Send Event with the Splunk HTTP Event Collector API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a GitLab trigger and Splunk HTTP Event Collector action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Commit (Instant) trigger
1. Connect your GitLab account
2. Select a Project ID
3. Optional- Select a Branch Name
Configure the Send Event action
1. Connect your Splunk HTTP Event Collector account
2. Configure Event Data
3. Configure Channel
4. Configure Sourcetype
5. Optional- Configure Index
6. Optional- Configure Host
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Commit (Instant) on GitLab

Description:Emit new event when a new commit is pushed to a branch

Version:0.1.3

Key:gitlab-new-commit

View on GitHub

GitLab Overview#

The GitLab API provides programmatic access to your GitLab projects, allowing you to automate common tasks, manage issues, merge requests, and more. With the GitLab API on Pipedream, you can create customized workflows that integrate with other services, streamline your development process, and enhance project management. By leveraging the power of serverless, you can set up triggers for GitLab events and perform actions across a variety of apps without managing infrastructure.

Trigger Code#

import gitlab from "../../gitlab.app.mjs";
import base from "../common/base.mjs";
import { eventTypes } from "../common/hook-events.mjs";

export default {
  ...base,
  key: "gitlab-new-commit",
  name: "New Commit (Instant)",
  description: "Emit new event when a new commit is pushed to a branch",
  version: "0.1.3",
  dedupe: "unique",
  type: "source",
  props: {
    ...base.props,
    refName: {
      propDefinition: [
        gitlab,
        "branch",
        (c) => ({
          projectId: c.projectId,
        }),
      ],
      optional: true,
    },
  },
  hooks: {
    ...base.hooks,
    async activate() {
      await this.activateHook(eventTypes.PUSH_EVENT);
    },
  },
  methods: {
    ...base.methods,
    isEventForThisBranch(branch) {
      return !this.refName || branch === this.refName;
    },
    generateMeta(commit) {
      const {
        id,
        message,
        shortId,
        committedDate,
      } = commit;
      return {
        id,
        summary: `New commit: ${message} (${shortId})`,
        ts: +new Date(committedDate),
      };
    },
    async emitEvent(event) {
      const refName = event.ref.split("refs/heads/").pop();
      if (!this.isEventForThisBranch(refName)) {
        return;
      }

      // Gitlab "push events" are only provisioned with at most
      // 20 commit objects (which also lack information when compared
      // to the Commits API). The amount of new commits is specified
      // in a separate variable called `total_commits_count`, which
      // we'll use to keep track of the commits that we need to emit
      // downstream.
      // See https://gitlab.com/help/user/project/integrations/webhooks#push-events
      const { total_commits_count: totalCommitsCount } = event;
      if (totalCommitsCount <= 0) return;

      const commits = await this.gitlab.listCommits(this.projectId, {
        params: {
          ref_name: refName,
          per_page: Math.min(50, totalCommitsCount),
        },
      });

      // We need to collect all the relevant commits, sort
      // them in reverse order (since the Gitlab API sorts them
      // from most to least recent) and emit an event for each
      // one of them.
      commits.reverse().forEach((commit) => {
        const meta = this.generateMeta(commit);
        this.$emit(commit, meta);
      });
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
GitLab	`gitlab`	`app`	This component uses the GitLab app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Project ID	`projectId`	`integer`	Select a value from the drop down menu.
Branch Name	`refName`	`string`	Select a value from the drop down menu.

Trigger Authentication#

GitLab uses OAuth authentication. When you connect your GitLab account, Pipedream will open a popup window where you can sign into GitLab and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any GitLab API.

Pipedream requests the following authorization scopes when you connect your account:

apiread_userread_repositorywrite_repositoryread_registrysudoopenidprofileemail

About GitLab#

GitLab is the most comprehensive AI-powered DevSecOps Platform.

Action#

Send Event on Splunk HTTP Event Collector

Description:Sends an event to Splunk HTTP Event Collector. [See the documentation](https://docs.splunk.com/Documentation/Splunk/8.2.0/RESTREF/RESTinput#services.2Fcollector.2Fevent)

Version:0.0.1

Key:splunk_http_event_collector-send-event

View on GitHub

Action Code#

import splunk from "../../splunk_http_event_collector.app.mjs";
import { parseJson } from "../../common/utils.mjs";

export default {
  key: "splunk_http_event_collector-send-event",
  name: "Send Event",
  description: "Sends an event to Splunk HTTP Event Collector. [See the documentation](https://docs.splunk.com/Documentation/Splunk/8.2.0/RESTREF/RESTinput#services.2Fcollector.2Fevent)",
  version: "0.0.1",
  type: "action",
  props: {
    splunk,
    eventData: {
      type: "string",
      label: "Event Data",
      description: "The event data to send to Splunk",
    },
    channel: {
      propDefinition: [
        splunk,
        "channel",
      ],
    },
    sourcetype: {
      propDefinition: [
        splunk,
        "sourcetype",
      ],
    },
    index: {
      propDefinition: [
        splunk,
        "index",
      ],
    },
    host: {
      propDefinition: [
        splunk,
        "host",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.splunk.sendEvent({
      $,
      params: {
        channel: this.channel,
      },
      data: {
        event: parseJson(this.eventData),
        sourcetype: this.sourcetype,
        index: this.index,
        host: this.host,
      },
    });
    $.export("$summary", "Successfully sent event to Splunk HTTP Event Collector");
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Splunk HTTP Event Collector	`splunk`	`app`	This component uses the Splunk HTTP Event Collector app.
Event Data	`eventData`	`string`	The event data to send to Splunk
Channel	`channel`	`string`	Channel GUID to differentiate data from different clients
Sourcetype	`sourcetype`	`string`	The sourcetype of the event
Index	`index`	`string`	The index to send the event to
Host	`host`	`string`	The host sending the event

Action Authentication#

Splunk HTTP Event Collector uses API keys for authentication. When you connect your Splunk HTTP Event Collector account, Pipedream securely stores the keys so you can easily authenticate to Splunk HTTP Event Collector APIs in both code and no-code steps.

Send Event with Splunk HTTP Event Collector API on New Commit (Instant) from GitLab API

Pipedream makes it easy to connect APIs for Splunk HTTP Event Collector, GitLab and 2,700+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,700+apps by most popular

1
-
24
of
2,700+
apps by most popular