logconfigurations

package
v2.48.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 3, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Code generated by tutone: DO NOT EDIT

Code generated by tutone: DO NOT EDIT

Index

Constants

View Source 
const LogConfigurationsCreateDataPartitionRuleMutation = `` /* 517-byte string literal not displayed */
View Source 
const LogConfigurationsCreateObfuscationExpressionMutation = `` /* 348-byte string literal not displayed */
View Source 
const LogConfigurationsCreateObfuscationRuleMutation = `` /* 570-byte string literal not displayed */
View Source 
const LogConfigurationsCreateParsingRuleMutation = `` /* 411-byte string literal not displayed */
View Source 
const LogConfigurationsDeleteDataPartitionRuleMutation = `` /* 157-byte string literal not displayed */
View Source 
const LogConfigurationsDeleteObfuscationExpressionMutation = `` /* 277-byte string literal not displayed */
View Source 
const LogConfigurationsDeleteObfuscationRuleMutation = `` /* 523-byte string literal not displayed */
View Source 
const LogConfigurationsDeleteParsingRuleMutation = `` /* 151-byte string literal not displayed */
View Source 
const LogConfigurationsUpdateDataPartitionRuleMutation = `` /* 516-byte string literal not displayed */
View Source 
const LogConfigurationsUpdateObfuscationExpressionMutation = `` /* 348-byte string literal not displayed */
View Source 
const LogConfigurationsUpdateObfuscationRuleMutation = `` /* 570-byte string literal not displayed */
View Source 
const LogConfigurationsUpdateParsingRuleMutation = `` /* 432-byte string literal not displayed */

Variables

View Source 
var LogConfigurationsCreateDataPartitionRuleErrorTypeTypes = struct {
	// A data partition rule with the provided name already exists.
	DUPLICATE_DATA_PARTITION_RULE_NAME LogConfigurationsCreateDataPartitionRuleErrorType
	// The provided data partition does not match the validation requirements
	INVALID_DATA_PARTITION_INPUT LogConfigurationsCreateDataPartitionRuleErrorType
	// Customer has reached the maximum number of allowed data partition rules.
	MAX_DATA_PARTITION_RULES LogConfigurationsCreateDataPartitionRuleErrorType
}{

	DUPLICATE_DATA_PARTITION_RULE_NAME: "DUPLICATE_DATA_PARTITION_RULE_NAME",

	INVALID_DATA_PARTITION_INPUT: "INVALID_DATA_PARTITION_INPUT",

	MAX_DATA_PARTITION_RULES: "MAX_DATA_PARTITION_RULES",
}
View Source 
var LogConfigurationsDataPartitionRuleMatchingOperatorTypes = struct {
	// When applying the rule will allocate data for those attributes that are an exact match with the provided value.
	EQUALS LogConfigurationsDataPartitionRuleMatchingOperator
	// When applying the rule will allocate data for those attributes that contain the provided value.
	LIKE LogConfigurationsDataPartitionRuleMatchingOperator
}{

	EQUALS: "EQUALS",

	LIKE: "LIKE",
}
View Source 
var LogConfigurationsDataPartitionRuleMutationErrorTypeTypes = struct {
	// Number format error. ID should be convertible to int.
	INVALID_ID LogConfigurationsDataPartitionRuleMutationErrorType
	// Partition rule must be specified with a valid nrql where clause
	INVALID_RULE LogConfigurationsDataPartitionRuleMutationErrorType
	// Couldn't find the provided data partition rule.
	NOT_FOUND LogConfigurationsDataPartitionRuleMutationErrorType
}{

	INVALID_ID: "INVALID_ID",

	INVALID_RULE: "INVALID_RULE",

	NOT_FOUND: "NOT_FOUND",
}
View Source 
var LogConfigurationsDataPartitionRuleRetentionPolicyTypeTypes = struct {
	// The alternative data retention policy, 30 days of data retention since the log data is ingested.
	SECONDARY LogConfigurationsDataPartitionRuleRetentionPolicyType
	// The maximum retention period associated with the account. This is determined by the customer’s subscription/contract with New Relic.
	STANDARD LogConfigurationsDataPartitionRuleRetentionPolicyType
}{

	SECONDARY: "SECONDARY",

	STANDARD: "STANDARD",
}
View Source 
var LogConfigurationsObfuscationMethodTypes = struct {
	// Replace the matched data with a SHA256 hash.
	HASH_SHA256 LogConfigurationsObfuscationMethod
	// Replace the matched data with a static value.
	MASK LogConfigurationsObfuscationMethod
}{

	HASH_SHA256: "HASH_SHA256",

	MASK: "MASK",
}
View Source 
var LogConfigurationsParsingRuleMutationErrorTypeTypes = struct {
	// Invalid Grok
	INVALID_GROK LogConfigurationsParsingRuleMutationErrorType
	// Number format error. ID should be convertible to int.
	INVALID_ID LogConfigurationsParsingRuleMutationErrorType
	// Invalid NRQL
	INVALID_NRQL LogConfigurationsParsingRuleMutationErrorType
	// Couldn't find the specified parsing rule.
	NOT_FOUND LogConfigurationsParsingRuleMutationErrorType
}{

	INVALID_GROK: "INVALID_GROK",

	INVALID_ID: "INVALID_ID",

	INVALID_NRQL: "INVALID_NRQL",

	NOT_FOUND: "NOT_FOUND",
}

Functions

This section is empty.

Types

type Account 

type Account struct {
	//
	ID int `json:"id,omitempty"`
	//
	LicenseKey string `json:"licenseKey,omitempty"`
	// This field provides access to LogConfigurations data.
	LogConfigurations LogConfigurationsAccountStitchedFields `json:"logConfigurations,omitempty"`
	//
	Name string `json:"name,omitempty"`
}

Account - The `Account` object provides general data about the account, as well as being the entry point into more detailed data about a single account.

Account configuration data is queried through this object, as well as telemetry data that is specific to a single account.

type Actor 

type Actor struct {
	// The `account` field is the entry point into data that is scoped to a single account.
	Account Account `json:"account,omitempty"`
}

Actor - The `Actor` object contains fields that are scoped to the API user's access level.

type LogConfigurationsAccountStitchedFields 

type LogConfigurationsAccountStitchedFields struct {
	// Look up for all data partition rules for a given account.
	DataPartitionRules []LogConfigurationsDataPartitionRule `json:"dataPartitionRules"`
	// Look up for all obfuscation expressions for a given account
	ObfuscationExpressions []LogConfigurationsObfuscationExpression `json:"obfuscationExpressions"`
	// Look up for all obfuscation rules for a given account.
	ObfuscationRules []LogConfigurationsObfuscationRule `json:"obfuscationRules"`
	// Look up for all parsing rules for a given account.
	ParsingRules []*LogConfigurationsParsingRule `json:"parsingRules"`
	// Test a Grok pattern against a list of log lines.
	TestGrok []LogConfigurationsGrokTestResult `json:"testGrok"`
}

LogConfigurationsAccountStitchedFields -

type LogConfigurationsCreateDataPartitionRuleError added in v2.5.0 

type LogConfigurationsCreateDataPartitionRuleError struct {
	// The message with the error cause.
	Message string `json:"message,omitempty"`
	// Type of error.
	Type LogConfigurationsCreateDataPartitionRuleErrorType `json:"type,omitempty"`
}

LogConfigurationsCreateDataPartitionRuleError - Expected errors as a result of creating a new data partition rule.

type LogConfigurationsCreateDataPartitionRuleErrorType added in v2.5.0 

type LogConfigurationsCreateDataPartitionRuleErrorType string

LogConfigurationsCreateDataPartitionRuleErrorType - Expected error types as result of creating a new data partition rule.

type LogConfigurationsCreateDataPartitionRuleInput added in v2.5.0 

type LogConfigurationsCreateDataPartitionRuleInput struct {
	// The description of the data partition rule.
	Description string `json:"description,omitempty"`
	// Whether or not this data partition rule is enabled.
	Enabled bool `json:"enabled"`
	// The matching criteria of the data partition rule.
	MatchingCriteria *LogConfigurationsDataPartitionRuleMatchingCriteriaInput `json:"matchingCriteria,omitempty"`
	// The NRQL to match events for this data partition rule. Logs matching this criteria will be routed to the specified data partition.
	NRQL NRQL `json:"nrql,omitempty"`
	// The retention policy of the data partition data.
	RetentionPolicy LogConfigurationsDataPartitionRuleRetentionPolicyType `json:"retentionPolicy"`
	// The name of the data partition where logs will be allocated once the rule is enabled.
	TargetDataPartition LogConfigurationsLogDataPartitionName `json:"targetDataPartition"`
}

LogConfigurationsCreateDataPartitionRuleInput - A new data partition rule.

type LogConfigurationsCreateDataPartitionRuleQueryResponse added in v2.5.0 

type LogConfigurationsCreateDataPartitionRuleQueryResponse struct {
	LogConfigurationsCreateDataPartitionRuleResponse LogConfigurationsCreateDataPartitionRuleResponse `json:"LogConfigurationsCreateDataPartitionRule"`
}

type LogConfigurationsCreateDataPartitionRuleResponse added in v2.5.0 

type LogConfigurationsCreateDataPartitionRuleResponse struct {
	// List of errors, if any.
	Errors []LogConfigurationsCreateDataPartitionRuleError `json:"errors,omitempty"`
	// The created data partition rule.
	Rule LogConfigurationsDataPartitionRule `json:"rule,omitempty"`
}

LogConfigurationsCreateDataPartitionRuleResponse - The result after creating a new data partition rule.

type LogConfigurationsCreateObfuscationActionInput added in v2.4.0 

type LogConfigurationsCreateObfuscationActionInput struct {
	// Attribute names for action. An empty list applies the action to all the attributes.
	Attributes []string `json:"attributes"`
	// Expression Id for action.
	ExpressionId string `json:"expressionId"`
	// Obfuscation method to use.
	Method LogConfigurationsObfuscationMethod `json:"method"`
}

LogConfigurationsCreateObfuscationActionInput - Input for creating an obfuscation action on a rule being created.

type LogConfigurationsCreateObfuscationExpressionInput 

type LogConfigurationsCreateObfuscationExpressionInput struct {
	// Description of expression.
	Description string `json:"description,omitempty"`
	// Name of expression.
	Name string `json:"name"`
	// Regex of expression.
	Regex string `json:"regex"`
}

LogConfigurationsCreateObfuscationExpressionInput - Input for creating an obfuscation expression.

type LogConfigurationsCreateObfuscationExpressionQueryResponse 

type LogConfigurationsCreateObfuscationExpressionQueryResponse struct {
	LogConfigurationsObfuscationExpression LogConfigurationsObfuscationExpression `json:"LogConfigurationsCreateObfuscationExpression"`
}

type LogConfigurationsCreateObfuscationRuleInput added in v2.4.0 

type LogConfigurationsCreateObfuscationRuleInput struct {
	// Actions for the rule. The actions will be applied in the order specified by this list.
	Actions []LogConfigurationsCreateObfuscationActionInput `json:"actions,omitempty"`
	// Description of rule.
	Description string `json:"description,omitempty"`
	// Whether the rule should be applied or not to incoming data.
	Enabled bool `json:"enabled"`
	// NRQL for determining whether a given log record should have obfuscation actions applied.
	Filter NRQL `json:"filter"`
	// Name of rule.
	Name string `json:"name"`
}

LogConfigurationsCreateObfuscationRuleInput - Input for creating an obfuscation rule.

type LogConfigurationsCreateObfuscationRuleQueryResponse added in v2.4.0 

type LogConfigurationsCreateObfuscationRuleQueryResponse struct {
	LogConfigurationsObfuscationRule LogConfigurationsObfuscationRule `json:"LogConfigurationsCreateObfuscationRule"`
}

type LogConfigurationsCreateParsingRuleQueryResponse added in v2.10.0 

type LogConfigurationsCreateParsingRuleQueryResponse struct {
	LogConfigurationsCreateParsingRuleResponse LogConfigurationsCreateParsingRuleResponse `json:"LogConfigurationsCreateParsingRule"`
}

type LogConfigurationsCreateParsingRuleResponse added in v2.10.0 

type LogConfigurationsCreateParsingRuleResponse struct {
	// List of errors, if any.
	Errors []LogConfigurationsParsingRuleMutationError `json:"errors,omitempty"`
	// The created parsing rule.
	Rule *LogConfigurationsParsingRule `json:"rule,omitempty"`
}

LogConfigurationsCreateParsingRuleResponse - The result after creating a new parsing rule.

type LogConfigurationsDataPartitionRule added in v2.5.0 

type LogConfigurationsDataPartitionRule struct {
	// Identifies the date and time when the rule was created.
	CreatedAt nrtime.DateTime `json:"createdAt"`
	// Identifies the user who has created the rule.
	CreatedBy UserReference `json:"createdBy,omitempty"`
	// Whether or not this data partition rule is deleted. Deleting a data partition rule does not delete the already persisted data. This data will be retained for a given period of time specified in the retention policy field.
	Deleted bool `json:"deleted"`
	// A description of what this data partition rule represents.
	Description string `json:"description,omitempty"`
	// Whether or not this data partition rule is enabled.
	Enabled bool `json:"enabled"`
	// Unique data partition rule identifier.
	ID string `json:"id"`
	// The matching criteria for this data partition rule. Logs matching this criteria will be routed to the specified data partition once the rule is enabled.
	MatchingCriteria LogConfigurationsDataPartitionRuleMatchingCriteria `json:"matchingCriteria,omitempty"`
	// The NRQL to match events for this data partition rule. Logs matching this criteria will be routed to the specified data partition once the rule is enabled.
	NRQL NRQL `json:"nrql,omitempty"`
	// The retention policy of the data partition data.
	RetentionPolicy LogConfigurationsDataPartitionRuleRetentionPolicyType `json:"retentionPolicy"`
	// The name of the data partition.
	TargetDataPartition LogConfigurationsLogDataPartitionName `json:"targetDataPartition"`
	// Identifies the date and time when the rule was last updated.
	UpdatedAt nrtime.DateTime `json:"updatedAt,omitempty"`
	// Identifies the user who has last updated the rule.
	UpdatedBy UserReference `json:"updatedBy,omitempty"`
}

LogConfigurationsDataPartitionRule - The data partition rule for an account.

type LogConfigurationsDataPartitionRuleMatchingCriteria added in v2.5.0 

type LogConfigurationsDataPartitionRuleMatchingCriteria struct {
	// The attribute name against which this matching condition will be evaluated.
	AttributeName string `json:"attributeName"`
	// The matching expression of the data partition rule definition.
	MatchingExpression string `json:"matchingExpression"`
	// The matching method of the data partition rule definition.
	MatchingOperator LogConfigurationsDataPartitionRuleMatchingOperator `json:"matchingOperator"`
}

LogConfigurationsDataPartitionRuleMatchingCriteria - The data partition rule matching criteria.

type LogConfigurationsDataPartitionRuleMatchingCriteriaInput added in v2.5.0 

type LogConfigurationsDataPartitionRuleMatchingCriteriaInput struct {
	// The attribute name against which this matching condition will be evaluated.
	AttributeName string `json:"attributeName"`
	// The matching expression of the data partition rule definition.
	MatchingExpression string `json:"matchingExpression"`
	// The matching method of the data partition rule definition.
	MatchingMethod LogConfigurationsDataPartitionRuleMatchingOperator `json:"matchingMethod"`
}

LogConfigurationsDataPartitionRuleMatchingCriteriaInput - The data partition rule matching criteria.

type LogConfigurationsDataPartitionRuleMatchingOperator added in v2.5.0 

type LogConfigurationsDataPartitionRuleMatchingOperator string

LogConfigurationsDataPartitionRuleMatchingOperator - The matching method for the rule to allocate the data partition data. Select EQUALS to target logs that match your criteria exactly, or select LIKE to apply a fuzzy match.

type LogConfigurationsDataPartitionRuleMutationError added in v2.5.0 

type LogConfigurationsDataPartitionRuleMutationError struct {
	// The message with the error cause.
	Message string `json:"message,omitempty"`
	// Type of error.
	Type LogConfigurationsDataPartitionRuleMutationErrorType `json:"type,omitempty"`
}

LogConfigurationsDataPartitionRuleMutationError - An object that contains expected errors as a result of mutating an existing data partition rule.

type LogConfigurationsDataPartitionRuleMutationErrorType added in v2.5.0 

type LogConfigurationsDataPartitionRuleMutationErrorType string

LogConfigurationsDataPartitionRuleMutationErrorType - Expected default error types as result of mutating an existing data partition rule.

type LogConfigurationsDataPartitionRuleRetentionPolicyType added in v2.5.0 

type LogConfigurationsDataPartitionRuleRetentionPolicyType string

LogConfigurationsDataPartitionRuleRetentionPolicyType - The retention policy for the data partition data.

type LogConfigurationsDeleteDataPartitionRuleQueryResponse added in v2.5.0 

type LogConfigurationsDeleteDataPartitionRuleQueryResponse struct {
	LogConfigurationsDeleteDataPartitionRuleResponse LogConfigurationsDeleteDataPartitionRuleResponse `json:"LogConfigurationsDeleteDataPartitionRule"`
}

type LogConfigurationsDeleteDataPartitionRuleResponse added in v2.5.0 

type LogConfigurationsDeleteDataPartitionRuleResponse struct {
	// List of errors, if any.
	Errors []LogConfigurationsDataPartitionRuleMutationError `json:"errors,omitempty"`
}

LogConfigurationsDeleteDataPartitionRuleResponse - The result after deleting a data partition rule.

type LogConfigurationsDeleteObfuscationExpressionQueryResponse 

type LogConfigurationsDeleteObfuscationExpressionQueryResponse struct {
	LogConfigurationsObfuscationExpression LogConfigurationsObfuscationExpression `json:"LogConfigurationsDeleteObfuscationExpression"`
}

type LogConfigurationsDeleteObfuscationRuleQueryResponse added in v2.4.0 

type LogConfigurationsDeleteObfuscationRuleQueryResponse struct {
	LogConfigurationsObfuscationRule LogConfigurationsObfuscationRule `json:"LogConfigurationsDeleteObfuscationRule"`
}

type LogConfigurationsDeleteParsingRuleQueryResponse added in v2.10.0 

type LogConfigurationsDeleteParsingRuleQueryResponse struct {
	LogConfigurationsDeleteParsingRuleResponse LogConfigurationsDeleteParsingRuleResponse `json:"LogConfigurationsDeleteParsingRule"`
}

type LogConfigurationsDeleteParsingRuleResponse added in v2.10.0 

type LogConfigurationsDeleteParsingRuleResponse struct {
	// List of errors, if any.
	Errors []LogConfigurationsParsingRuleMutationError `json:"errors,omitempty"`
}

LogConfigurationsDeleteParsingRuleResponse - The result after deleting a parsing rule.

type LogConfigurationsGrokTestExtractedAttribute added in v2.9.0 

type LogConfigurationsGrokTestExtractedAttribute struct {
	// The attribute name.
	Name string `json:"name"`
	// A string representation of the extracted value (which might not be a String).
	Value string `json:"value"`
}

LogConfigurationsGrokTestExtractedAttribute - An attribute that was extracted from a Grok test.

type LogConfigurationsGrokTestResult added in v2.9.0 

type LogConfigurationsGrokTestResult struct {
	// Any attributes that were extracted.
	Attributes []LogConfigurationsGrokTestExtractedAttribute `json:"attributes"`
	// The log line that was tested against.
	LogLine string `json:"logLine"`
	// Whether the Grok pattern matched.
	Matched bool `json:"matched"`
}

LogConfigurationsGrokTestResult - The result of testing Grok on a log line.

type LogConfigurationsLogDataPartitionName added in v2.5.0 

type LogConfigurationsLogDataPartitionName string

LogConfigurationsLogDataPartitionName - The name of a log data partition. Has to start with 'Log_' prefix and can only contain alphanumeric characters and underscores.

type LogConfigurationsObfuscationAction added in v2.4.0 

type LogConfigurationsObfuscationAction struct {
	// Log record attributes to apply this expression to. An empty list applies the action to all the attributes.
	Attributes []string `json:"attributes"`
	// Obfuscation expression applied by this action.
	Expression LogConfigurationsObfuscationExpression `json:"expression"`
	// The id of the obfuscation action.
	ID string `json:"id"`
	// How to obfuscate matches for the applied expression.
	Method LogConfigurationsObfuscationMethod `json:"method"`
}

LogConfigurationsObfuscationAction - Application of an obfuscation expression with specific a replacement method.

type LogConfigurationsObfuscationExpression 

type LogConfigurationsObfuscationExpression struct {
	// Identifies the date and time when the expression was created.
	CreatedAt nrtime.DateTime `json:"createdAt"`
	// Identifies the user who has created the expression.
	CreatedBy UserReference `json:"createdBy,omitempty"`
	// Description of the expression.
	Description string `json:"description,omitempty"`
	// The id of the obfuscation expression.
	ID string `json:"id"`
	// Name of the expression.
	Name string `json:"name"`
	// Regular expression for this obfuscation expression. Capture groups will be obscured on matching.
	Regex string `json:"regex"`
	// Identifies the date and time when the expression was last updated.
	UpdatedAt nrtime.DateTime `json:"updatedAt"`
	// Identifies the user who has last updated the expression.
	UpdatedBy UserReference `json:"updatedBy,omitempty"`
}

LogConfigurationsObfuscationExpression - Reusable obfuscation expression.

type LogConfigurationsObfuscationMethod added in v2.4.0 

type LogConfigurationsObfuscationMethod string

LogConfigurationsObfuscationMethod - Methods for replacing obfuscated values.

type LogConfigurationsObfuscationRule added in v2.4.0 

type LogConfigurationsObfuscationRule struct {
	// Obfuscation actions to take if a record passes the matching criteria.
	Actions []LogConfigurationsObfuscationAction `json:"actions"`
	// Identifies the date and time when the rule was created.
	CreatedAt nrtime.DateTime `json:"createdAt"`
	// Identifies the user who has created the rule.
	CreatedBy UserReference `json:"createdBy,omitempty"`
	// Description of the obfuscation rule.
	Description string `json:"description,omitempty"`
	// Whether the rule should be applied to incoming logs
	Enabled bool `json:"enabled"`
	// NRQL filter to determine if a log record should have obfuscation actions applied.
	Filter NRQL `json:"filter"`
	// The id of the obfuscation rule.
	ID string `json:"id"`
	// Name of the obfuscation rule.
	Name string `json:"name"`
	// Identifies the date and time when the rule was last updated.
	UpdatedAt nrtime.DateTime `json:"updatedAt"`
	// Identifies the user who has last updated the rule.
	UpdatedBy UserReference `json:"updatedBy,omitempty"`
}

LogConfigurationsObfuscationRule - Rule for identifying a set of log data to apply specific obfuscation actions to.

type LogConfigurationsParsingRule added in v2.10.0 

type LogConfigurationsParsingRule struct {
	// The account id associated with the rule.
	AccountID int `json:"accountId"`
	// The parsing rule will apply to value of this attribute.
	Attribute string `json:"attribute"`
	// Identifies the user who has created the rule.
	CreatedBy UserReference `json:"createdBy,omitempty"`
	// Whether or not this rule is deleted.
	Deleted bool `json:"deleted"`
	// A description of what this parsing rule represents.
	Description string `json:"description"`
	// Whether or not this rule is enabled.
	Enabled bool `json:"enabled"`
	// The Grok of what to parse.
	Grok string `json:"grok"`
	// Unique parsing rule identifier.
	ID string `json:"id"`
	// The Lucene to match events to the parsing rule.
	Lucene string `json:"lucene"`
	// The NRQL to match events to the parsing rule.
	NRQL NRQL `json:"nrql"`
	// Identifies the date and time when the rule was last updated.
	UpdatedAt nrtime.DateTime `json:"updatedAt,omitempty"`
	// Identifies the user who has last updated the rule.
	UpdatedBy UserReference `json:"updatedBy,omitempty"`
}

LogConfigurationsParsingRule - A parsing rule for an account.

type LogConfigurationsParsingRuleConfiguration added in v2.10.0 

type LogConfigurationsParsingRuleConfiguration struct {
	// The parsing rule will apply to value of this attribute. If field is not provided, value will default to message.
	Attribute string `json:"attribute,omitempty"`
	// A description of what this parsing rule represents.
	Description string `json:"description"`
	// Whether or not this rule is enabled.
	Enabled bool `json:"enabled"`
	// The Grok of what to parse.
	Grok string `json:"grok"`
	// The Lucene to match events to the parsing rule.
	Lucene string `json:"lucene"`
	// The NRQL to match events to the parsing rule.
	NRQL NRQL `json:"nrql"`
}

LogConfigurationsParsingRuleConfiguration - A new parsing rule.

type LogConfigurationsParsingRuleMutationError added in v2.10.0 

type LogConfigurationsParsingRuleMutationError struct {
	// The message with the error cause.
	Message string `json:"message,omitempty"`
	// Type of error.
	Type LogConfigurationsParsingRuleMutationErrorType `json:"type,omitempty"`
}

LogConfigurationsParsingRuleMutationError - Expected errors as a result of mutating a parsing rule.

type LogConfigurationsParsingRuleMutationErrorType added in v2.10.0 

type LogConfigurationsParsingRuleMutationErrorType string

LogConfigurationsParsingRuleMutationErrorType - Expected default error types as result of mutating an existing parsing rule.

type LogConfigurationsUpdateDataPartitionRuleInput added in v2.5.0 

type LogConfigurationsUpdateDataPartitionRuleInput struct {
	// The description of the data partition rule.
	Description string `json:"description,omitempty"`
	// Whether or not this data partition rule is enabled.
	// NOTE: DO NOT add 'omitempty' to the JSON description of Enabled as fetched from Tutone.
	// It omits 'enabled' even if the calling service sends it as 'false', which is why 'omitempty' has been manually discarded.
	Enabled bool `json:"enabled"`
	// Unique data partition rule identifier.
	ID string `json:"id"`
	// The criteria of the data partition rule.
	MatchingCriteria *LogConfigurationsDataPartitionRuleMatchingCriteriaInput `json:"matchingCriteria,omitempty"`
	// The NRQL to match events for this data partition rule. Logs matching this criteria will be routed to the specified data partition.
	NRQL NRQL `json:"nrql,omitempty"`
}

LogConfigurationsUpdateDataPartitionRuleInput - An object for updating an existing data partition rule.

type LogConfigurationsUpdateDataPartitionRuleQueryResponse added in v2.5.0 

type LogConfigurationsUpdateDataPartitionRuleQueryResponse struct {
	LogConfigurationsUpdateDataPartitionRuleResponse LogConfigurationsUpdateDataPartitionRuleResponse `json:"LogConfigurationsUpdateDataPartitionRule"`
}

type LogConfigurationsUpdateDataPartitionRuleResponse added in v2.5.0 

type LogConfigurationsUpdateDataPartitionRuleResponse struct {
	// List of errors, if any.
	Errors []LogConfigurationsDataPartitionRuleMutationError `json:"errors,omitempty"`
	// The updated data partition rule.
	Rule LogConfigurationsDataPartitionRule `json:"rule,omitempty"`
}

LogConfigurationsUpdateDataPartitionRuleResponse - An object that represents the result after updating a data partition rule.

type LogConfigurationsUpdateObfuscationActionInput added in v2.4.0 

type LogConfigurationsUpdateObfuscationActionInput struct {
	// Attribute names for action. An empty list applies the action to all the attributes.
	Attributes []string `json:"attributes"`
	// Expression Id for action.
	ExpressionId string `json:"expressionId"`
	// Obfuscation method to use.
	Method LogConfigurationsObfuscationMethod `json:"method"`
}

LogConfigurationsUpdateObfuscationActionInput - Input for creating an obfuscation action on a rule being updated.

type LogConfigurationsUpdateObfuscationExpressionInput 

type LogConfigurationsUpdateObfuscationExpressionInput struct {
	// Description of expression.
	Description string `json:"description,omitempty"`
	// Expression Id.
	ID string `json:"id"`
	// Name of expression.
	Name string `json:"name,omitempty"`
	// Regex of expression.
	Regex string `json:"regex,omitempty"`
}

LogConfigurationsUpdateObfuscationExpressionInput - Input for updating an obfuscation expression. Null fields are left untouched by mutation.

type LogConfigurationsUpdateObfuscationExpressionQueryResponse 

type LogConfigurationsUpdateObfuscationExpressionQueryResponse struct {
	LogConfigurationsObfuscationExpression LogConfigurationsObfuscationExpression `json:"LogConfigurationsUpdateObfuscationExpression"`
}

type LogConfigurationsUpdateObfuscationRuleInput added in v2.4.0 

type LogConfigurationsUpdateObfuscationRuleInput struct {
	// Actions for the rule. When non-null, this list of actions is used to replace
	// the existing list of actions of the rule. The actions will be applied in the
	// order specified by this list.
	Actions []LogConfigurationsUpdateObfuscationActionInput `json:"actions,omitempty"`
	// Description of rule.
	Description string `json:"description,omitempty"`
	// Whether the rule should be applied or not to incoming data.
	Enabled bool `json:"enabled,omitempty"`
	// NRQL for determining whether a given log record should have obfuscation actions applied.
	Filter NRQL `json:"filter,omitempty"`
	// Rule Id.
	ID string `json:"id"`
	// Name of rule.
	Name string `json:"name,omitempty"`
}

LogConfigurationsUpdateObfuscationRuleInput - Input for updating an obfuscation rule. Null fields are left untouched by mutation.

type LogConfigurationsUpdateObfuscationRuleQueryResponse added in v2.4.0 

type LogConfigurationsUpdateObfuscationRuleQueryResponse struct {
	LogConfigurationsObfuscationRule LogConfigurationsObfuscationRule `json:"LogConfigurationsUpdateObfuscationRule"`
}

type LogConfigurationsUpdateParsingRuleQueryResponse added in v2.10.0 

type LogConfigurationsUpdateParsingRuleQueryResponse struct {
	LogConfigurationsUpdateParsingRuleResponse LogConfigurationsUpdateParsingRuleResponse `json:"LogConfigurationsUpdateParsingRule"`
}

type LogConfigurationsUpdateParsingRuleResponse added in v2.10.0 

type LogConfigurationsUpdateParsingRuleResponse struct {
	// List of errors, if any.
	Errors []LogConfigurationsParsingRuleMutationError `json:"errors,omitempty"`
	// The updated parsing rule.
	Rule *LogConfigurationsParsingRule `json:"rule,omitempty"`
}

LogConfigurationsUpdateParsingRuleResponse - The result after updating a parsing rule.

type Logconfigurations 

type Logconfigurations struct {
	// contains filtered or unexported fields
}

Obfuscation is used to communicate with the New Relic Obfuscation product.

func New 

func New(config config.Config) Logconfigurations

New is used to create a new Obfuscation expression.

func (*Logconfigurations) GetDataPartitionRules added in v2.5.0 

func (a *Logconfigurations) GetDataPartitionRules(
	accountID int,
) (*[]LogConfigurationsDataPartitionRule, error)

Look up for all data partition rules for a given account.

func (*Logconfigurations) GetDataPartitionRulesWithContext added in v2.5.0 

func (a *Logconfigurations) GetDataPartitionRulesWithContext(
	ctx context.Context,
	accountID int,
) (*[]LogConfigurationsDataPartitionRule, error)

Look up for all data partition rules for a given account.

func (*Logconfigurations) GetObfuscationExpressions 

func (a *Logconfigurations) GetObfuscationExpressions(
	accountID int,
) (*[]LogConfigurationsObfuscationExpression, error)

Look up for all obfuscation expressions for a given account

func (*Logconfigurations) GetObfuscationExpressionsWithContext 

func (a *Logconfigurations) GetObfuscationExpressionsWithContext(
	ctx context.Context,
	accountID int,
) (*[]LogConfigurationsObfuscationExpression, error)

Look up for all obfuscation expressions for a given account

func (*Logconfigurations) GetObfuscationRules added in v2.4.0 

func (a *Logconfigurations) GetObfuscationRules(
	accountID int,
) (*[]LogConfigurationsObfuscationRule, error)

Look up for all obfuscation rules for a given account.

func (*Logconfigurations) GetObfuscationRulesWithContext added in v2.4.0 

func (a *Logconfigurations) GetObfuscationRulesWithContext(
	ctx context.Context,
	accountID int,
) (*[]LogConfigurationsObfuscationRule, error)

Look up for all obfuscation rules for a given account.

func (*Logconfigurations) GetParsingRules added in v2.10.0 

func (a *Logconfigurations) GetParsingRules(
	accountID int,
) (*[]*LogConfigurationsParsingRule, error)

Look up for all parsing rules for a given account.

func (*Logconfigurations) GetParsingRulesWithContext added in v2.10.0 

func (a *Logconfigurations) GetParsingRulesWithContext(
	ctx context.Context,
	accountID int,
) (*[]*LogConfigurationsParsingRule, error)

Look up for all parsing rules for a given account.

func (*Logconfigurations) GetTestGrok added in v2.9.0 

func (a *Logconfigurations) GetTestGrok(
	accountID int,
	grok string,
	logLines []string,
) (*[]LogConfigurationsGrokTestResult, error)

Test a Grok pattern against a list of log lines.

func (*Logconfigurations) GetTestGrokWithContext added in v2.9.0 

func (a *Logconfigurations) GetTestGrokWithContext(
	ctx context.Context,
	accountID int,
	grok string,
	logLines []string,
) (*[]LogConfigurationsGrokTestResult, error)

Test a Grok pattern against a list of log lines.

func (*Logconfigurations) LogConfigurationsCreateDataPartitionRule added in v2.5.0 

func (a *Logconfigurations) LogConfigurationsCreateDataPartitionRule(
	accountID int,
	rule LogConfigurationsCreateDataPartitionRuleInput,
) (*LogConfigurationsCreateDataPartitionRuleResponse, error)

Create a new data partition rule.

func (*Logconfigurations) LogConfigurationsCreateDataPartitionRuleWithContext added in v2.5.0 

func (a *Logconfigurations) LogConfigurationsCreateDataPartitionRuleWithContext(
	ctx context.Context,
	accountID int,
	rule LogConfigurationsCreateDataPartitionRuleInput,
) (*LogConfigurationsCreateDataPartitionRuleResponse, error)

Create a new data partition rule.

func (*Logconfigurations) LogConfigurationsCreateObfuscationExpression 

func (a *Logconfigurations) LogConfigurationsCreateObfuscationExpression(
	accountID int,
	expression LogConfigurationsCreateObfuscationExpressionInput,
) (*LogConfigurationsObfuscationExpression, error)

Create an obfuscation expression.

func (*Logconfigurations) LogConfigurationsCreateObfuscationExpressionWithContext 

func (a *Logconfigurations) LogConfigurationsCreateObfuscationExpressionWithContext(
	ctx context.Context,
	accountID int,
	expression LogConfigurationsCreateObfuscationExpressionInput,
) (*LogConfigurationsObfuscationExpression, error)

Create an obfuscation expression.

func (*Logconfigurations) LogConfigurationsCreateObfuscationRule added in v2.4.0 

func (a *Logconfigurations) LogConfigurationsCreateObfuscationRule(
	accountID int,
	rule LogConfigurationsCreateObfuscationRuleInput,
) (*LogConfigurationsObfuscationRule, error)

Create an obfuscation rule.

func (*Logconfigurations) LogConfigurationsCreateObfuscationRuleWithContext added in v2.4.0 

func (a *Logconfigurations) LogConfigurationsCreateObfuscationRuleWithContext(
	ctx context.Context,
	accountID int,
	rule LogConfigurationsCreateObfuscationRuleInput,
) (*LogConfigurationsObfuscationRule, error)

Create an obfuscation rule.

func (*Logconfigurations) LogConfigurationsCreateParsingRule added in v2.10.0 

func (a *Logconfigurations) LogConfigurationsCreateParsingRule(
	accountID int,
	rule LogConfigurationsParsingRuleConfiguration,
) (*LogConfigurationsCreateParsingRuleResponse, error)

Create a new parsing rule.

func (*Logconfigurations) LogConfigurationsCreateParsingRuleWithContext added in v2.10.0 

func (a *Logconfigurations) LogConfigurationsCreateParsingRuleWithContext(
	ctx context.Context,
	accountID int,
	rule LogConfigurationsParsingRuleConfiguration,
) (*LogConfigurationsCreateParsingRuleResponse, error)

Create a new parsing rule.

func (*Logconfigurations) LogConfigurationsDeleteDataPartitionRule added in v2.5.0 

func (a *Logconfigurations) LogConfigurationsDeleteDataPartitionRule(
	accountID int,
	iD string,
) (*LogConfigurationsDeleteDataPartitionRuleResponse, error)

Delete an existing data partition rule. This operation will result in data to be allocated in the main NRDB storage (Log) if no other data partition rule exists intercepting the logs matching this rule. A deleted data partition rule can be recreated using the same name.

func (*Logconfigurations) LogConfigurationsDeleteDataPartitionRuleWithContext added in v2.5.0 

func (a *Logconfigurations) LogConfigurationsDeleteDataPartitionRuleWithContext(
	ctx context.Context,
	accountID int,
	iD string,
) (*LogConfigurationsDeleteDataPartitionRuleResponse, error)

Delete an existing data partition rule. This operation will result in data to be allocated in the main NRDB storage (Log) if no other data partition rule exists intercepting the logs matching this rule. A deleted data partition rule can be recreated using the same name.

func (*Logconfigurations) LogConfigurationsDeleteObfuscationExpression 

func (a *Logconfigurations) LogConfigurationsDeleteObfuscationExpression(
	accountID int,
	iD string,
) (*LogConfigurationsObfuscationExpression, error)

Delete an obfuscation expression.

func (*Logconfigurations) LogConfigurationsDeleteObfuscationExpressionWithContext 

func (a *Logconfigurations) LogConfigurationsDeleteObfuscationExpressionWithContext(
	ctx context.Context,
	accountID int,
	iD string,
) (*LogConfigurationsObfuscationExpression, error)

Delete an obfuscation expression.

func (*Logconfigurations) LogConfigurationsDeleteObfuscationRule added in v2.4.0 

func (a *Logconfigurations) LogConfigurationsDeleteObfuscationRule(
	accountID int,
	iD string,
) (*LogConfigurationsObfuscationRule, error)

Delete an obfuscation rule.

func (*Logconfigurations) LogConfigurationsDeleteObfuscationRuleWithContext added in v2.4.0 

func (a *Logconfigurations) LogConfigurationsDeleteObfuscationRuleWithContext(
	ctx context.Context,
	accountID int,
	iD string,
) (*LogConfigurationsObfuscationRule, error)

Delete an obfuscation rule.

func (*Logconfigurations) LogConfigurationsDeleteParsingRule added in v2.10.0 

func (a *Logconfigurations) LogConfigurationsDeleteParsingRule(
	accountID int,
	iD string,
) (*LogConfigurationsDeleteParsingRuleResponse, error)

Delete an existing parsing rule.

func (*Logconfigurations) LogConfigurationsDeleteParsingRuleWithContext added in v2.10.0 

func (a *Logconfigurations) LogConfigurationsDeleteParsingRuleWithContext(
	ctx context.Context,
	accountID int,
	iD string,
) (*LogConfigurationsDeleteParsingRuleResponse, error)

Delete an existing parsing rule.

func (*Logconfigurations) LogConfigurationsUpdateDataPartitionRule added in v2.5.0 

func (a *Logconfigurations) LogConfigurationsUpdateDataPartitionRule(
	accountID int,
	rule LogConfigurationsUpdateDataPartitionRuleInput,
) (*LogConfigurationsUpdateDataPartitionRuleResponse, error)

Update an existing data partition rule.

func (*Logconfigurations) LogConfigurationsUpdateDataPartitionRuleWithContext added in v2.5.0 

func (a *Logconfigurations) LogConfigurationsUpdateDataPartitionRuleWithContext(
	ctx context.Context,
	accountID int,
	rule LogConfigurationsUpdateDataPartitionRuleInput,
) (*LogConfigurationsUpdateDataPartitionRuleResponse, error)

Update an existing data partition rule.

func (*Logconfigurations) LogConfigurationsUpdateObfuscationExpression 

func (a *Logconfigurations) LogConfigurationsUpdateObfuscationExpression(
	accountID int,
	expression LogConfigurationsUpdateObfuscationExpressionInput,
) (*LogConfigurationsObfuscationExpression, error)

Update an existing data partition rule.

func (*Logconfigurations) LogConfigurationsUpdateObfuscationExpressionWithContext 

func (a *Logconfigurations) LogConfigurationsUpdateObfuscationExpressionWithContext(
	ctx context.Context,
	accountID int,
	expression LogConfigurationsUpdateObfuscationExpressionInput,
) (*LogConfigurationsObfuscationExpression, error)

Update an existing data partition rule.

func (*Logconfigurations) LogConfigurationsUpdateObfuscationRule added in v2.4.0 

func (a *Logconfigurations) LogConfigurationsUpdateObfuscationRule(
	accountID int,
	rule LogConfigurationsUpdateObfuscationRuleInput,
) (*LogConfigurationsObfuscationRule, error)

Update an existing data partition rule.

func (*Logconfigurations) LogConfigurationsUpdateObfuscationRuleWithContext added in v2.4.0 

func (a *Logconfigurations) LogConfigurationsUpdateObfuscationRuleWithContext(
	ctx context.Context,
	accountID int,
	rule LogConfigurationsUpdateObfuscationRuleInput,
) (*LogConfigurationsObfuscationRule, error)

Update an existing data partition rule.

func (*Logconfigurations) LogConfigurationsUpdateParsingRule added in v2.10.0 

func (a *Logconfigurations) LogConfigurationsUpdateParsingRule(
	accountID int,
	iD string,
	rule LogConfigurationsParsingRuleConfiguration,
) (*LogConfigurationsUpdateParsingRuleResponse, error)

Update an existing parsing rule.

func (*Logconfigurations) LogConfigurationsUpdateParsingRuleWithContext added in v2.10.0 

func (a *Logconfigurations) LogConfigurationsUpdateParsingRuleWithContext(
	ctx context.Context,
	accountID int,
	iD string,
	rule LogConfigurationsParsingRuleConfiguration,
) (*LogConfigurationsUpdateParsingRuleResponse, error)

Update an existing parsing rule.

type NRQL added in v2.4.0 

type NRQL string

NRQL - This scalar represents a NRQL query string.

See the [NRQL Docs](https://docs.newrelic.com/docs/insights/nrql-new-relic-query-language/nrql-resources/nrql-syntax-components-functions) for more information about NRQL syntax.

type UserReference 

type UserReference struct {
	//
	Email string `json:"email,omitempty"`
	//
	Gravatar string `json:"gravatar,omitempty"`
	//
	ID int `json:"id,omitempty"`
	//
	Name string `json:"name,omitempty"`
}

UserReference - The `UserReference` object provides basic identifying information about the user.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.