Graylog customization

Graylog customization tailors inputs, extractors, streams, dashboards and API-driven configuration to your log sources so teams can investigate events and repeat the setup across environments. This page explains what the work covers, what drives its cost, and what you need to provide.

On this page

What Graylog customization covers

Graylog customization is the ongoing shaping of a running or planned deployment so that it matches your logs and your teams. In practice it covers custom inputs and extractors for each log source family, streams and index sets for each data type, dashboards and event definitions built for specific teams, content packs that package configuration for reuse, and automation of configuration through the REST API. Each of these is configuration you must be able to explain, reproduce and hand over, not a one-time setup step.

Common triggers are a new source type that does not parse cleanly, a team that needs its own views and alerts, the same build repeated across development, test and production, and configuration that drifts or breaks after a Graylog upgrade. Before work starts, list your log source families, the streams each should land in, which teams own which dashboards and event definitions, and where the configuration is stored. Those answers determine how much of this can be done by hand and how much needs to be scripted and versioned.

In-house or partner: a team with one or two log sources and an administrator comfortable with the web interface can often build these pieces itself. Partners are usually asked in when configuration must be repeatable across environments, reviewed before it changes, and still working after upgrades. Confirm with your own team which of those three requirements apply before deciding.

Pipeline rule design and lookup table enrichment are covered in the processing and parsing topic, and the first production rollout is covered in the implementation topic. This section stays with the surrounding configuration: inputs, streams, index sets, content packs, dashboards, event definitions and API-driven changes.

What the work includes

Customization work is delivered as a set of named artifacts that your team can review, version and operate after the project closes. The packages below show what you receive and which decisions each one forces.

Source inventory with inputs and extractors

We list every log source, its transport (syslog, GELF, Beats or another supported input), its expected format and the owning team. Each source gets a documented input configuration and the extractors that parse its fields. Check that the inventory matches what is actually sending, because unlisted sources are the usual reason parsing drifts after go-live.

Stream and index set design

Streams route messages by data type, and each stream writes to an index set with its own rotation and retention settings. The design work decides how many index sets you need, which rotation strategy applies to each (by message count, size or time) and how long each one keeps data. Confirm retention targets with the data owners before the index sets are created, since changing them later affects existing indices.

Processing pipeline rules and lookup tables

Pipeline rules handle parsing, enrichment and routing beyond what extractors can do. Each rule set is tested against sample messages and kept under version control with a short note on its purpose. Lookup tables feed enrichment such as asset ownership or threat lists. Confirm who owns the lookup data and how often it refreshes, because stale tables produce confident but wrong enrichment.

Dashboards, saved searches and team access

Dashboards and saved searches are built for named teams, such as platform operations or the security team, and are scoped to the streams those teams are allowed to read. Access design sits alongside this work: confirm which roles can edit shared content and which can only view it. Review the set with each team lead, since dashboards built without a named owner tend to go stale.

Event definitions and notification channels

Event definitions turn searches into alerts for real-time and historical monitoring. Each definition is tied to a notification channel the platform supports, which the Graylog Open product page lists as PagerDuty, Slack and email. Check the threshold, the grace period between repeated alerts and the on-call route for each definition before it is enabled, because noisy alerts are the usual reason teams stop reading them.

Content packs and REST API automation

Content packs package inputs, streams, pipelines and dashboards so the same configuration can be deployed to a test or second environment. REST API scripts automate repeatable tasks, and they need a defined credential approach: service accounts, scoped tokens and secrets kept out of scripts. The exact content pack and automation scope depends on your edition, so confirm in writing which features your license covers before the design is fixed.

Change runbook and test evidence

The change runbook describes how to add a source, edit a pipeline rule or change an event definition, including who approves the change and how to roll it back. Test evidence records replayed or non-production traffic run through each new rule, showing expected field output and routing. Ask for both before handover, since the runbook is what your operators will use after the project team leaves.

What drives cost and duration

This table lists the factors that change the size of a Graylog customization project, why each one matters and what to do to keep it contained.

DriverWhy it mattersHow to keep it down
Number and type of log sourcesRaw text lines need custom extractors and pipeline rules for every field, while structured JSON or Beats input maps to fields with far less work.Inventory sources first, group them by format, and prioritize structured sources or move text sources to structured output at the shipper.
Number of teams and dashboard setsEach team typically wants its own searches, dashboards, streams and access roles, and every set needs review and testing.Agree a shared dashboard standard and a small number of reusable templates before build starts.
Environments and configuration promotionPipeline rules, lookup tables, content packs and event definitions must move from test to production without drift, and manual copying adds rework.Export configuration as content packs or scripted API calls, and keep the promotion steps written down and repeatable.
Depth of REST API automationScripted configuration of inputs, streams and alerts saves repeated effort but adds code to build, version and maintain.Automate the repetitive objects first and confirm which endpoints your Graylog version supports before scripting.
Edition features that change what can be builtEnterprise and Security add features such as the correlation engine and compliance packs, which change what can be built and packaged. Confirm which of these apply to your edition and license before design.Decide the edition during scoping, and list only the features you actually need in the design.
Stream and index set changes after go-liveChanging streams, index sets or routing after data is flowing can require re-indexing decisions, retention changes and updated searches.Freeze the stream and index set design at sign-off and route changes through a documented change process.
Upgrade cadence and compatibility checksEach Graylog minor release and its MongoDB and OpenSearch or Data Node requirements must be checked against custom pipelines, plugins and content packs.Keep customizations in version-controlled exports and run a test upgrade on a copy before each planned upgrade.
Data classification and access requirementsSensitive log fields may need masking, restricted streams and role-based access, which adds design and testing work for each data class.Classify data types early and limit the number of distinct access roles to those the classes need.
Documentation and handover expectationsRunbooks, pipeline rule descriptions, dashboard owners and API scripts must be handed over for your team to operate the platform after the project.Agree the documentation list and acceptance criteria in the written scope before work starts.

How the project runs

The sequence moves from a documented inventory of your logs to a Graylog configuration that your team can change, test and operate without DeployOpen involved.

  1. Inventory sources and agree ownership

    DeployOpen collects sample messages from each log source, builds a field dictionary and records the owner who approves each source and field. The step closes with a signed-off inventory that lists sources, sample messages, fields and owners, which sets the scope for every later phase.

  2. Design inputs, extractors, streams and index sets

    The inventory is turned into a design that maps each source to an input, each message format to extractors or pipeline rules, each data type to a stream and each stream to an index set with its rotation and retention settings. The step closes with a design document that the owners have reviewed and accepted.

  3. Build in a non-production environment

    The design is implemented on a non-production Graylog deployment that matches the production platform, including server nodes, MongoDB and the search backend. The step closes when every input, extractor, stream, index set and pipeline rule from the design exists in that environment and is recorded in version control.

  4. Package content and automation

    Reusable configuration is exported as content packs, and repeatable setup tasks such as stream creation or REST API calls are written as automation scripts. The step closes with versioned packages that can be installed on another Graylog instance and reproduce the same configuration.

  5. Test with sample and live-like traffic

    Parsing and routing are tested with the saved sample messages, then with replayed or live-like traffic that includes malformed and unexpected events. Rollback is rehearsed by reinstalling the previous content pack and confirming that the prior configuration returns. The step closes with a test record showing expected and actual results for each source.

  6. Promote to production with a change record

    The approved packages are installed on production under a change record that names the content version, the approver, the window and the rollback steps. The step closes when production matches the tested configuration and the change record is filed with the owners' sign-off.

  7. Hand over runbooks and an agreed owner

    DeployOpen delivers runbooks for adding a source, changing a rule, rotating an index set and rolling back a content pack, and confirms the owner who will run the platform. The step closes when your team has completed a supervised change using the runbook and the owner has accepted responsibility for the configuration.

What teams keep and what they outsource

This table compares the customization work a Graylog team usually runs day to day with the reusable build and automation work that is often handed to a partner, and lists the skills each part needs.

Work partUsually in-houseUsually outsourcedSkills needed
Fields and events that matterOperators and analysts choose which fields, sources and event types each team watchesFacilitated workshop to map log sources to team questions and to document the field naming standardSecurity or operations domain knowledge, familiarity with the log sources
Dashboards and saved searchesTeam owners build and adjust dashboards and saved searches for their own questionsStarter set of reviewed dashboards and searches that teams then copy and modifyGraylog search syntax, dashboard widgets, clear naming conventions
Extractor patterns for many sourcesOwners request new sources and validate that fields appear as expectedDesigning a reusable extractor pattern set (grok, JSON, regex) across syslog, Beats and GELF sources, with test messagesGrok and regex, JSON structure, Graylog input and extractor configuration
Content packsTeams install approved packs and report gapsPackaging inputs, extractors, streams, pipelines and dashboards into versioned content packs with install notesContent pack format, dependency management, export and import testing
REST API automationTeams run approved scripts and review outputWriting and reviewing automation for content deployment, using least-privilege tokens scoped per taskGraylog REST API, token management, scripting, secrets handling
Configuration change controlOwners submit changes through agreed review and approval stepsDefining the change control workflow, promotion path from test to production, and rollback stepsChange management practice, Git or equivalent version control, Graylog configuration export
Upgrade regression checksTeams confirm critical dashboards and alerts still work after each releaseWriting the regression test list and running it against each Graylog 7.x minor release before productionKnowledge of Graylog release notes, pipeline testing, alert and event definition checks
Access model per team and streamTeam leads approve who needs access to which dataDesigning role and stream permissions that match team boundaries and the organization's access policyGraylog roles and stream permissions, identity group mapping, least-privilege design

What usually goes wrong

Most Graylog customization problems appear after the build is finished, when a source changes, a teammate leaves or an upgrade lands. The cards below cover the failure modes we see most often and the checks that prevent each one.

Extractors that break on format changes

Extractors and pipeline rules are written against today's log lines. When an application adds a field, renames a key or changes a timestamp format, parsing fails quietly and events stop matching. Keep sample messages from each source in version control, and test rules against them before each change reaches production traffic.

Hand-built dashboards that drift

Dashboards created by clicking in the web interface differ between development, test and production within weeks. Stream names, field names and index sets then no longer match across environments. Export dashboards as content packs or scripted definitions and review changes the same way as code.

Content packs with environment-specific values

Exports can carry internal IDs, hostnames, lookup table sources and credentials that only exist in one environment. Importing them elsewhere creates broken references or leaks secrets. Before export, remove environment values and move them into per-environment configuration, and confirm that no secret appears in the exported file.

Automation running with administrator tokens

REST API scripts for stream creation, index set changes or alert updates often run with a broad administrator token kept in a shell profile or CI variable. A leaked token then grants full control of the cluster. Create a dedicated service user with only the roles each script needs, store its token in a secrets manager, and rotate it on a schedule.

Stream and index set changes that break searches

Moving a source to another stream or index set can silently remove it from saved searches, dashboards and event definitions that point at the old location. Alerts may keep running but see no data. Before changing routing, list every dependent search, dashboard and alert, and verify each one returns expected results afterward.

Custom content skipped in upgrade checks

Custom pipeline functions, plugins and content packs are not covered by the standard upgrade path. They can fail after a server, MongoDB or OpenSearch change even when the core product passes. Check custom content against the Graylog compatibility matrix for the target version in a staging environment before any production upgrade.

Overbuilt dashboards and noisy alerts

Teams add widgets and event definitions for every question they can imagine. Dashboards become slow to load and event notifications fire so often that people mute the channel. Limit each dashboard to a named decision, review alert volume and false positives regularly, and retire definitions nobody acts on.

No named owner after handover

When a project ends, extractors, rules, alerts and scripts often have no clear owner. Nobody knows which changes are approved or who responds when an alert fails. Assign a named owner for each stream, pipeline and event definition in the handover, and record how changes are requested and reviewed.

How the work changes by starting point

When Graylog is already running and people depend on its searches and alerts, the main constraint is not breaking what works today. Design changes are made so that existing streams, pipelines and event definitions keep their behavior while new logic is added beside them.

  • Design: Map every current stream, pipeline rule and event definition before changing anything, and route new processing through separate streams so existing routing stays intact.
  • Testing: Replay representative recent messages through candidate rules and compare alert counts against production for a period you agree in advance.
  • Handover: Document which alerts and dashboards were changed, with their previous versions, so on-call staff can tell a new alert from an altered one.
  • Change control: Confirm with your change board whether a maintenance window is required for pipeline or index set changes.

What you need to provide

Gaps in sample data are the most common cause of rework in Graylog customization. Before any extractor or pipeline rule is written, provide sanitized sample logs for each source, including the failure cases: malformed lines, multi-line events, fields that are sometimes missing, and values that changed after a software update. Without the bad lines, parsing is tested only against clean input, and the rules break the first time production traffic arrives. Each sample should be labeled with the source system, its version and the expected output.

Provide a field dictionary for the logs in scope, or the names of the people who know what each field means. Include the expected data types, units, timestamp formats and which fields carry personal or sensitive data, since these affect extractor design, stream routing and index set choices. Name one owner for each team and one owner for each log source. Owners approve field naming, stream membership and alert logic, and they are the people who decide when a conflicting request is resolved. Without named owners, decisions stall in review.

Grant administrator access to a non-production Graylog that matches the production version and input types, and agree on the route by which approved configuration reaches production. Confirm how API tokens will be issued, scoped and rotated, and where they and other secrets will be stored. Agree the change window and the approval steps for each production change, including who signs off on pipeline rules that drop or reroute data. Also confirm the target Graylog version and the planned upgrade path, because extractors, content packs and API calls can behave differently across releases.

Decide which edition features are in scope before design starts. Graylog Open and the Enterprise and Security subscriptions differ in authentication options, correlation, data tiering and SIEM content, so a customization that depends on a feature your edition lacks will be rebuilt later. Confirm this with Graylog's current product pages and your licensing contract, and record the decision in the statement of work so the build and the quote reflect the same feature set.

Frequently asked questions

How much does Graylog customization cost?

The cost follows from a written scope, because DeployOpen does not publish a price list. The main components are discovery of log sources and parsing needs, building inputs, extractors, pipeline rules, lookup tables, streams, index sets, dashboards and alerts, testing against sample traffic, and documentation for handover. Cost rises with the number of sources, parsing complexity and the number of approval steps. Ask for the one-time build effort and any recurring retainer as separate line items, with each deliverable named.

How long does a Graylog customization project take?

Duration depends on how many log sources need custom work, how complex their formats are, and how many approvals each change needs. The timing is set in the written scope before work starts, with milestones for discovery, build, testing and handover. Sources with clean, documented formats move quickly. Multi-line events, inconsistent fields or several owners who must sign off on changes take longer. Ask the vendor to list the assumptions the timeline depends on, such as access to sample logs and a test environment.

Can our own team customize Graylog without a partner?

Yes, for a small set of sources with simple extractors. A team can usually handle a few inputs, JSON or grok extractors and basic pipeline rules if it has Linux and Graylog administration skills, comfort with regular expressions and grok patterns, and working knowledge of the Graylog REST API for repeatable changes. It also needs version control for exported content and a non-production Graylog environment for testing. Larger source sets, multi-stage pipelines and lookup-driven enrichment are where an outside review often prevents rework.

Does Graylog Open include the features we need, or do we need Enterprise or Security?

It depends on the specific feature, so confirm each one against the current Graylog pricing and product pages before deciding. Graylog Open includes inputs, streams, processing pipelines, search, dashboards, event definitions and Active Directory, LDAP and trusted header authentication. Graylog Enterprise adds a data lake with archive restore, data tiering, a correlation engine, Okta, OpenID Connect and SAML, and 24/7 support. Graylog Security adds SIEM features such as risk scoring and compliance packs. Pricing starts at 15,000 US dollars per year for Enterprise and 18,000 for Security, per the Graylog pricing page.

Do custom pipelines and extractors survive Graylog upgrades?

They can, but only when each upgrade is checked against the compatibility matrix and covered by regression tests. Before upgrading, confirm the target Graylog 7.x release supports your MongoDB and OpenSearch or Data Node versions. Export custom content such as pipelines, extractors, lookup tables and dashboards, then replay sample messages to confirm parsing and routing still produce the same fields. OpenSearch 1.x has been deprecated since Graylog 7.0 and will be removed in Graylog 8.0. Ongoing upgrade and support work can be covered by a retainer, with terms set in writing.

What do we need to provide for a Graylog customization project?

You provide access and information, because DeployOpen works inside your environment. This usually means a Graylog environment to work in, with a non-production instance for testing, administrator access through agreed accounts, and sample messages from each log source that show representative volume and edge cases. You should also name the people who approve changes, the owner of each log source, your retention and index requirements, and which data types are sensitive. The written scope should list each dependency and who is responsible for it.

How DeployOpen delivers Graylog customization

DeployOpen plans, builds, documents and supports Graylog customization inside your own infrastructure, from inputs and extractors through processing pipelines, lookup tables, streams, index sets, dashboards and REST API automation. Engagements are fixed-scope, with the scope agreed in writing before work starts.

How we scope

  • We inventory your log sources, input types and the parsing each one needs before any configuration is written.
  • The written scope lists the inputs, extractors, pipeline rules, lookup tables, streams, index sets and dashboards included.
  • We confirm which Graylog edition and search backend your customizations depend on, so features are not assumed.

How we build

  • Pipeline rules, extractors and lookup tables are built in a non-production Graylog environment first.
  • Each rule is tested against representative sample messages, including malformed and unexpected events.
  • Dashboards, streams and index sets are configured together so routing and retention match the agreed design.

How we hand over

  • You receive a written record of inputs, pipeline stages, stream routing and index set settings as delivered.
  • Content packs and REST API scripts used for repeatable configuration are documented and handed over with their owners named.
  • Your team walks through the configuration with us so they can change rules and dashboards without outside help.

How we support

  • Ongoing support, upgrades and continuous testing are available as a retainer after handover.
  • Changes to parsing or routing go through the same test-before-production steps used during the build.
  • We can plan changes around Graylog release and compatibility updates that affect your customizations.

Sources and further reading

Talk to our team.

Tell us what you're working on, whether it's a deployment, an audit, a security test or a cyber range. You'll speak with an engineer who can help you scope it.

  • 30-minute call: free, with no obligation.
  • NDA on request: we can sign before you share details.
  • Clear next steps: a scope and plan after the call.