ParserExtension class

A parser extension allows customers to extend or customize the behavior of an existing prebuilt or custom parser. It enables extracting additional fields from raw logs without modifying the base parser.

To get more information about ParserExtension, see:

• API documentation
• How-to Guides
• Custom parsers overview

Example Usage

Chronicle Parserextension Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const example = new gcp.chronicle.ParserExtension("example", {
    location: "us",
    instance: "00000000-0000-0000-0000-000000000000",
    logType: "CISCO_DHCP",
    validationSkipped: true,
    cbnSnippet: "ZHVtbXkgZXh0ZW5zaW9uIHNuaXBwZXQ=",
});

import pulumi
import pulumi_gcp as gcp

example = gcp.chronicle.ParserExtension("example",
    location="us",
    instance="00000000-0000-0000-0000-000000000000",
    log_type="CISCO_DHCP",
    validation_skipped=True,
    cbn_snippet="ZHVtbXkgZXh0ZW5zaW9uIHNuaXBwZXQ=")

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var example = new Gcp.Chronicle.ParserExtension("example", new()
    {
        Location = "us",
        Instance = "00000000-0000-0000-0000-000000000000",
        LogType = "CISCO_DHCP",
        ValidationSkipped = true,
        CbnSnippet = "ZHVtbXkgZXh0ZW5zaW9uIHNuaXBwZXQ=",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/chronicle"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := chronicle.NewParserExtension(ctx, "example", &chronicle.ParserExtensionArgs{
			Location:          pulumi.String("us"),
			Instance:          pulumi.String("00000000-0000-0000-0000-000000000000"),
			LogType:           pulumi.String("CISCO_DHCP"),
			ValidationSkipped: pulumi.Bool(true),
			CbnSnippet:        pulumi.String("ZHVtbXkgZXh0ZW5zaW9uIHNuaXBwZXQ="),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_chronicle_parserextension" "example" {
  location           = "us"
  instance           = "00000000-0000-0000-0000-000000000000"
  log_type           = "CISCO_DHCP"
  validation_skipped = true
  cbn_snippet        = "ZHVtbXkgZXh0ZW5zaW9uIHNuaXBwZXQ="
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.chronicle.ParserExtension;
import com.pulumi.gcp.chronicle.ParserExtensionArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ParserExtension("example", ParserExtensionArgs.builder()
            .location("us")
            .instance("00000000-0000-0000-0000-000000000000")
            .logType("CISCO_DHCP")
            .validationSkipped(true)
            .cbnSnippet("ZHVtbXkgZXh0ZW5zaW9uIHNuaXBwZXQ=")
            .build());

    }
}

resources:
  example:
    type: gcp:chronicle:ParserExtension
    properties:
      location: us
      instance: 00000000-0000-0000-0000-000000000000
      logType: CISCO_DHCP
      validationSkipped: true
      cbnSnippet: ZHVtbXkgZXh0ZW5zaW9uIHNuaXBwZXQ=

Chronicle Parserextension Full

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const example = new gcp.chronicle.ParserExtension("example", {
    location: "us",
    instance: "00000000-0000-0000-0000-000000000000",
    logType: "AKAMAI_DHCP",
    validationSkipped: true,
    log: "ZHVtbXkgbG9n",
    fieldExtractors: {
        logFormat: "JSON",
        appendRepeatedFields: true,
        preprocessConfig: {
            grokRegex: "(?P<message>.*)",
            target: "message",
        },
        extractors: [
            {
                fieldPath: "$.user",
                destinationPath: "udm.principal.user.userid",
                value: "static-override",
            },
            {
                fieldPath: "$.event",
                destinationPath: "udm.metadata.event_type",
                preconditionOp: "EQUALS",
                preconditionPath: "$.event",
                preconditionValue: "login",
            },
        ],
    },
});

import pulumi
import pulumi_gcp as gcp

example = gcp.chronicle.ParserExtension("example",
    location="us",
    instance="00000000-0000-0000-0000-000000000000",
    log_type="AKAMAI_DHCP",
    validation_skipped=True,
    log="ZHVtbXkgbG9n",
    field_extractors={
        "log_format": "JSON",
        "append_repeated_fields": True,
        "preprocess_config": {
            "grok_regex": "(?P<message>.*)",
            "target": "message",
        },
        "extractors": [
            {
                "field_path": "$.user",
                "destination_path": "udm.principal.user.userid",
                "value": "static-override",
            },
            {
                "field_path": "$.event",
                "destination_path": "udm.metadata.event_type",
                "precondition_op": "EQUALS",
                "precondition_path": "$.event",
                "precondition_value": "login",
            },
        ],
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var example = new Gcp.Chronicle.ParserExtension("example", new()
    {
        Location = "us",
        Instance = "00000000-0000-0000-0000-000000000000",
        LogType = "AKAMAI_DHCP",
        ValidationSkipped = true,
        Log = "ZHVtbXkgbG9n",
        FieldExtractors = new Gcp.Chronicle.Inputs.ParserExtensionFieldExtractorsArgs
        {
            LogFormat = "JSON",
            AppendRepeatedFields = true,
            PreprocessConfig = new Gcp.Chronicle.Inputs.ParserExtensionFieldExtractorsPreprocessConfigArgs
            {
                GrokRegex = "(?P<message>.*)",
                Target = "message",
            },
            Extractors = new[]
            {
                new Gcp.Chronicle.Inputs.ParserExtensionFieldExtractorsExtractorArgs
                {
                    FieldPath = "$.user",
                    DestinationPath = "udm.principal.user.userid",
                    Value = "static-override",
                },
                new Gcp.Chronicle.Inputs.ParserExtensionFieldExtractorsExtractorArgs
                {
                    FieldPath = "$.event",
                    DestinationPath = "udm.metadata.event_type",
                    PreconditionOp = "EQUALS",
                    PreconditionPath = "$.event",
                    PreconditionValue = "login",
                },
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/chronicle"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := chronicle.NewParserExtension(ctx, "example", &chronicle.ParserExtensionArgs{
			Location:          pulumi.String("us"),
			Instance:          pulumi.String("00000000-0000-0000-0000-000000000000"),
			LogType:           pulumi.String("AKAMAI_DHCP"),
			ValidationSkipped: pulumi.Bool(true),
			Log:               pulumi.String("ZHVtbXkgbG9n"),
			FieldExtractors: &chronicle.ParserExtensionFieldExtractorsArgs{
				LogFormat:            pulumi.String("JSON"),
				AppendRepeatedFields: pulumi.Bool(true),
				PreprocessConfig: &chronicle.ParserExtensionFieldExtractorsPreprocessConfigArgs{
					GrokRegex: pulumi.String("(?P<message>.*)"),
					Target:    pulumi.String("message"),
				},
				Extractors: chronicle.ParserExtensionFieldExtractorsExtractorArray{
					&chronicle.ParserExtensionFieldExtractorsExtractorArgs{
						FieldPath:       pulumi.String("$.user"),
						DestinationPath: pulumi.String("udm.principal.user.userid"),
						Value:           pulumi.String("static-override"),
					},
					&chronicle.ParserExtensionFieldExtractorsExtractorArgs{
						FieldPath:         pulumi.String("$.event"),
						DestinationPath:   pulumi.String("udm.metadata.event_type"),
						PreconditionOp:    pulumi.String("EQUALS"),
						PreconditionPath:  pulumi.String("$.event"),
						PreconditionValue: pulumi.String("login"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_chronicle_parserextension" "example" {
  location           = "us"
  instance           = "00000000-0000-0000-0000-000000000000"
  log_type           = "AKAMAI_DHCP"
  validation_skipped = true
  log                = "ZHVtbXkgbG9n"
  field_extractors = {
    log_format             = "JSON"
    append_repeated_fields = true
    preprocess_config = {
      grok_regex = "(?P<message>.*)"
      target     = "message"
    }
    extractors = [{
      "fieldPath"       = "$.user"
      "destinationPath" = "udm.principal.user.userid"
      "value"           = "static-override"
      }, {
      "fieldPath"         = "$.event"
      "destinationPath"   = "udm.metadata.event_type"
      "preconditionOp"    = "EQUALS"
      "preconditionPath"  = "$.event"
      "preconditionValue" = "login"
    }]
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.chronicle.ParserExtension;
import com.pulumi.gcp.chronicle.ParserExtensionArgs;
import com.pulumi.gcp.chronicle.inputs.ParserExtensionFieldExtractorsArgs;
import com.pulumi.gcp.chronicle.inputs.ParserExtensionFieldExtractorsPreprocessConfigArgs;
import com.pulumi.gcp.chronicle.inputs.ParserExtensionFieldExtractorsExtractorArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ParserExtension("example", ParserExtensionArgs.builder()
            .location("us")
            .instance("00000000-0000-0000-0000-000000000000")
            .logType("AKAMAI_DHCP")
            .validationSkipped(true)
            .log("ZHVtbXkgbG9n")
            .fieldExtractors(ParserExtensionFieldExtractorsArgs.builder()
                .logFormat("JSON")
                .appendRepeatedFields(true)
                .preprocessConfig(ParserExtensionFieldExtractorsPreprocessConfigArgs.builder()
                    .grokRegex("(?P<message>.*)")
                    .target("message")
                    .build())
                .extractors(
                    ParserExtensionFieldExtractorsExtractorArgs.builder()
                        .fieldPath("$.user")
                        .destinationPath("udm.principal.user.userid")
                        .value("static-override")
                        .build(),
                    ParserExtensionFieldExtractorsExtractorArgs.builder()
                        .fieldPath("$.event")
                        .destinationPath("udm.metadata.event_type")
                        .preconditionOp("EQUALS")
                        .preconditionPath("$.event")
                        .preconditionValue("login")
                        .build())
                .build())
            .build());

    }
}

resources:
  example:
    type: gcp:chronicle:ParserExtension
    properties:
      location: us
      instance: 00000000-0000-0000-0000-000000000000
      logType: AKAMAI_DHCP
      validationSkipped: true
      log: ZHVtbXkgbG9n
      fieldExtractors:
        logFormat: JSON
        appendRepeatedFields: true
        preprocessConfig:
          grokRegex: (?P<message>.*)
          target: message
        extractors:
          - fieldPath: $.user
            destinationPath: udm.principal.user.userid
            value: static-override
          - fieldPath: $.event
            destinationPath: udm.metadata.event_type
            preconditionOp: EQUALS
            preconditionPath: $.event
            preconditionValue: login

Chronicle Parserextension Dynamic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const example = new gcp.chronicle.ParserExtension("example", {
    location: "us",
    instance: "00000000-0000-0000-0000-000000000000",
    logType: "AKAMAI_DHCP",
    validationSkipped: true,
    log: "ZHVtbXkgbG9n",
    dynamicParsing: {
        optedFields: [{
            path: "$.ip",
            sampleValue: "1.1.1.1",
        }],
    },
});

import pulumi
import pulumi_gcp as gcp

example = gcp.chronicle.ParserExtension("example",
    location="us",
    instance="00000000-0000-0000-0000-000000000000",
    log_type="AKAMAI_DHCP",
    validation_skipped=True,
    log="ZHVtbXkgbG9n",
    dynamic_parsing={
        "opted_fields": [{
            "path": "$.ip",
            "sample_value": "1.1.1.1",
        }],
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var example = new Gcp.Chronicle.ParserExtension("example", new()
    {
        Location = "us",
        Instance = "00000000-0000-0000-0000-000000000000",
        LogType = "AKAMAI_DHCP",
        ValidationSkipped = true,
        Log = "ZHVtbXkgbG9n",
        DynamicParsing = new Gcp.Chronicle.Inputs.ParserExtensionDynamicParsingArgs
        {
            OptedFields = new[]
            {
                new Gcp.Chronicle.Inputs.ParserExtensionDynamicParsingOptedFieldArgs
                {
                    Path = "$.ip",
                    SampleValue = "1.1.1.1",
                },
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/chronicle"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := chronicle.NewParserExtension(ctx, "example", &chronicle.ParserExtensionArgs{
			Location:          pulumi.String("us"),
			Instance:          pulumi.String("00000000-0000-0000-0000-000000000000"),
			LogType:           pulumi.String("AKAMAI_DHCP"),
			ValidationSkipped: pulumi.Bool(true),
			Log:               pulumi.String("ZHVtbXkgbG9n"),
			DynamicParsing: &chronicle.ParserExtensionDynamicParsingArgs{
				OptedFields: chronicle.ParserExtensionDynamicParsingOptedFieldArray{
					&chronicle.ParserExtensionDynamicParsingOptedFieldArgs{
						Path:        pulumi.String("$.ip"),
						SampleValue: pulumi.String("1.1.1.1"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_chronicle_parserextension" "example" {
  location           = "us"
  instance           = "00000000-0000-0000-0000-000000000000"
  log_type           = "AKAMAI_DHCP"
  validation_skipped = true
  log                = "ZHVtbXkgbG9n"
  dynamic_parsing = {
    opted_fields = [{
      "path"        = "$.ip"
      "sampleValue" = "1.1.1.1"
    }]
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.chronicle.ParserExtension;
import com.pulumi.gcp.chronicle.ParserExtensionArgs;
import com.pulumi.gcp.chronicle.inputs.ParserExtensionDynamicParsingArgs;
import com.pulumi.gcp.chronicle.inputs.ParserExtensionDynamicParsingOptedFieldArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ParserExtension("example", ParserExtensionArgs.builder()
            .location("us")
            .instance("00000000-0000-0000-0000-000000000000")
            .logType("AKAMAI_DHCP")
            .validationSkipped(true)
            .log("ZHVtbXkgbG9n")
            .dynamicParsing(ParserExtensionDynamicParsingArgs.builder()
                .optedFields(ParserExtensionDynamicParsingOptedFieldArgs.builder()
                    .path("$.ip")
                    .sampleValue("1.1.1.1")
                    .build())
                .build())
            .build());

    }
}

resources:
  example:
    type: gcp:chronicle:ParserExtension
    properties:
      location: us
      instance: 00000000-0000-0000-0000-000000000000
      logType: AKAMAI_DHCP
      validationSkipped: true
      log: ZHVtbXkgbG9n
      dynamicParsing:
        optedFields:
          - path: $.ip
            sampleValue: 1.1.1.1

Import

ParserExtension can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/instances/{{instance}}/logTypes/{{log_type}}/parserExtensions/{{parserextension}}
• {{project}}/{{location}}/{{instance}}/{{log_type}}/{{parserextension}}
• {{location}}/{{instance}}/{{log_type}}/{{parserextension}}

When using the pulumi import command, ParserExtension can be imported using one of the formats above. For example:

$ pulumi import gcp:chronicle/parserExtension:ParserExtension default projects/{{project}}/locations/{{location}}/instances/{{instance}}/logTypes/{{log_type}}/parserExtensions/{{parserextension}}
$ pulumi import gcp:chronicle/parserExtension:ParserExtension default {{project}}/{{location}}/{{instance}}/{{log_type}}/{{parserextension}}
$ pulumi import gcp:chronicle/parserExtension:ParserExtension default {{location}}/{{instance}}/{{log_type}}/{{parserextension}}

Constructors

ParserExtension(String name, {ParserExtensionArgs? args, CustomResourceOptions? options})

Creates a new ParserExtension. name The Pulumi resource name. args Arguments used to configure this ParserExtension. The set of arguments for ParserExtension. options Resource options controlling this resource's behavior.

ParserExtension.reference(String urn)

Creates a typed reference to an existing ParserExtension resource.

Properties

cbnSnippet ↔ Output<String?>

Parser config could be a cbn snippet.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

The time the parser extension was created.

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

dynamicParsing ↔ Output<ParserExtensionDynamicParsing?>

A representation of a parser extension as dynamic parsing config. Structure is documented below.

late, final

extensionValidationReport ↔ Output<String>

The latest extension validation report for this extension.

late, final

fieldExtractors ↔ Output<ParserExtensionFieldExtractors?>

A representation of a parser extension as a set of field extractors. Structure is documented below.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

instance ↔ Output<String>

Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.

late, final

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

lastLiveTime ↔ Output<String>

The time the config was last serving live traffic.

late, final

location ↔ Output<String>

Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.

late, final

log ↔ Output<String?>

Raw log used to assist the user in creation of augmentation.

late, final

logType ↔ Output<String>

Resource ID segment making up resource name. It identifies the resource within its parent collection as described in https://google.aip.dev/122.

late, final

name ↔ Output<String>

Format: projects/{project}/locations/{location}/instances/{instance}/logTypes/{logtype}/parserExtensions/{parserExtension}

late, final

parserextension ↔ Output<String>

Output only. The server-generated ID of the parser extension.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

state ↔ Output<String>

The state of the parser extension Possible values: NEW VALIDATING LIVE REJECTED INTERNAL_ERROR VALIDATED ARCHIVED VALIDATION_SKIPPED

late, final

stateLastChangedTime ↔ Output<String>

The time the config state was last changed.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

validationReport ↔ Output<String>

The validation report generated during extension validation.

late, final

validationSkipped ↔ Output<bool?>

Flag to bypass parser extension validation. If enabled, the parser extension won't be rejected during the validation phase and validation will be skipped.

late, final

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {ParserExtensionState? state, CustomResourceOptions? options}) → ParserExtension

Gets an existing ParserExtension resource's state with the given name and id.