Docs Packages
  1. Packages
  2. Dynatrace
  3. API Docs
  4. UserSessionMetrics
Dynatrace v0.1.0 published on Wednesday, May 24, 2023 by Lbrlabs
lbrlabs/pulumi-dynatrace

dynatrace.UserSessionMetrics

Explore with Pulumi AI

dynatrace logo
Dynatrace v0.1.0 published on Wednesday, May 24, 2023 by Lbrlabs
lbrlabs/pulumi-dynatrace

    Create UserSessionMetrics Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new UserSessionMetrics(name: string, args: UserSessionMetricsArgs, opts?: CustomResourceOptions);
    @overload
def UserSessionMetrics(resource_name: str,
                       args: UserSessionMetricsArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def UserSessionMetrics(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       enabled: Optional[bool] = None,
                       metric_key: Optional[str] = None,
                       value: Optional[UserSessionMetricsValueArgs] = None,
                       dimensions: Optional[Sequence[str]] = None,
                       filters: Optional[UserSessionMetricsFiltersArgs] = None)
    func NewUserSessionMetrics(ctx *Context, name string, args UserSessionMetricsArgs, opts ...ResourceOption) (*UserSessionMetrics, error)
    public UserSessionMetrics(string name, UserSessionMetricsArgs args, CustomResourceOptions? opts = null)
    public UserSessionMetrics(String name, UserSessionMetricsArgs args)
public UserSessionMetrics(String name, UserSessionMetricsArgs args, CustomResourceOptions options)

    type: dynatrace:UserSessionMetrics
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args UserSessionMetricsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UserSessionMetricsArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UserSessionMetricsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserSessionMetricsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserSessionMetricsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var userSessionMetricsResource = new Dynatrace.UserSessionMetrics("userSessionMetricsResource", new()
{
    Enabled = false,
    MetricKey = "string",
    Value = new Dynatrace.Inputs.UserSessionMetricsValueArgs
    {
        Type = "string",
        FieldName = "string",
    },
    Dimensions = new[]
    {
        "string",
    },
    Filters = new Dynatrace.Inputs.UserSessionMetricsFiltersArgs
    {
        Filters = new[]
        {
            new Dynatrace.Inputs.UserSessionMetricsFiltersFilterArgs
            {
                FieldName = "string",
                Operator = "string",
                Value = "string",
                ValueIns = new[]
                {
                    "string",
                },
            },
        },
    },
});

    example, err := dynatrace.NewUserSessionMetrics(ctx, "userSessionMetricsResource", &dynatrace.UserSessionMetricsArgs{
	Enabled:   pulumi.Bool(false),
	MetricKey: pulumi.String("string"),
	Value: &dynatrace.UserSessionMetricsValueArgs{
		Type:      pulumi.String("string"),
		FieldName: pulumi.String("string"),
	},
	Dimensions: pulumi.StringArray{
		pulumi.String("string"),
	},
	Filters: &dynatrace.UserSessionMetricsFiltersArgs{
		Filters: dynatrace.UserSessionMetricsFiltersFilterArray{
			&dynatrace.UserSessionMetricsFiltersFilterArgs{
				FieldName: pulumi.String("string"),
				Operator:  pulumi.String("string"),
				Value:     pulumi.String("string"),
				ValueIns: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
	},
})

    var userSessionMetricsResource = new UserSessionMetrics("userSessionMetricsResource", UserSessionMetricsArgs.builder()        
    .enabled(false)
    .metricKey("string")
    .value(UserSessionMetricsValueArgs.builder()
        .type("string")
        .fieldName("string")
        .build())
    .dimensions("string")
    .filters(UserSessionMetricsFiltersArgs.builder()
        .filters(UserSessionMetricsFiltersFilterArgs.builder()
            .fieldName("string")
            .operator("string")
            .value("string")
            .valueIns("string")
            .build())
        .build())
    .build());

    user_session_metrics_resource = dynatrace.UserSessionMetrics("userSessionMetricsResource",
    enabled=False,
    metric_key="string",
    value=dynatrace.UserSessionMetricsValueArgs(
        type="string",
        field_name="string",
    ),
    dimensions=["string"],
    filters=dynatrace.UserSessionMetricsFiltersArgs(
        filters=[dynatrace.UserSessionMetricsFiltersFilterArgs(
            field_name="string",
            operator="string",
            value="string",
            value_ins=["string"],
        )],
    ))

    const userSessionMetricsResource = new dynatrace.UserSessionMetrics("userSessionMetricsResource", {
    enabled: false,
    metricKey: "string",
    value: {
        type: "string",
        fieldName: "string",
    },
    dimensions: ["string"],
    filters: {
        filters: [{
            fieldName: "string",
            operator: "string",
            value: "string",
            valueIns: ["string"],
        }],
    },
});

    type: dynatrace:UserSessionMetrics
properties:
    dimensions:
        - string
    enabled: false
    filters:
        filters:
            - fieldName: string
              operator: string
              value: string
              valueIns:
                - string
    metricKey: string
    value:
        fieldName: string
        type: string

    UserSessionMetrics Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The UserSessionMetrics resource accepts the following input properties:

    Enabled bool
    This setting is enabled (true) or disabled (false)
    MetricKey string
    Metric key
    Value Lbrlabs.PulumiPackage.Dynatrace.Inputs.UserSessionMetricsValue
    Defines the type of value to be extracted from the user session. When using User session counter, the number of user sessions is counted (similar to count(*) when using USQL). When using User session field value, the value of a user session field is extracted.
    Dimensions List<string>
    Defines the fields that are used as dimensions. A dimension is a collection of reference information about a metric data point that is of interest to your business. Dimensions are parameters like "browserFamily", "userType", "country". For example, using "userType" as a dimension allows you to split chart data based on user types.
    Filters Lbrlabs.PulumiPackage.Dynatrace.Inputs.UserSessionMetricsFilters
    Defines the filters for the user session. Filters apply at the moment of extracting the data and only sessions that satisfy the filtering criteria will be used to extract the custom metrics. You will not be able to modify these filters in the metric data explorer. For example, using "userType equals REAL_USER" will give you only data from real users, while forcing the synthetic sessions to be ignored.
    Enabled bool
    This setting is enabled (true) or disabled (false)
    MetricKey string
    Metric key
    Value UserSessionMetricsValueArgs
    Defines the type of value to be extracted from the user session. When using User session counter, the number of user sessions is counted (similar to count(*) when using USQL). When using User session field value, the value of a user session field is extracted.
    Dimensions []string
    Defines the fields that are used as dimensions. A dimension is a collection of reference information about a metric data point that is of interest to your business. Dimensions are parameters like "browserFamily", "userType", "country". For example, using "userType" as a dimension allows you to split chart data based on user types.
    Filters UserSessionMetricsFiltersArgs
    Defines the filters for the user session. Filters apply at the moment of extracting the data and only sessions that satisfy the filtering criteria will be used to extract the custom metrics. You will not be able to modify these filters in the metric data explorer. For example, using "userType equals REAL_USER" will give you only data from real users, while forcing the synthetic sessions to be ignored.
    enabled Boolean
    This setting is enabled (true) or disabled (false)
    metricKey String
    Metric key
    value UserSessionMetricsValue
    Defines the type of value to be extracted from the user session. When using User session counter, the number of user sessions is counted (similar to count(*) when using USQL). When using User session field value, the value of a user session field is extracted.
    dimensions List<String>
    Defines the fields that are used as dimensions. A dimension is a collection of reference information about a metric data point that is of interest to your business. Dimensions are parameters like "browserFamily", "userType", "country". For example, using "userType" as a dimension allows you to split chart data based on user types.
    filters UserSessionMetricsFilters
    Defines the filters for the user session. Filters apply at the moment of extracting the data and only sessions that satisfy the filtering criteria will be used to extract the custom metrics. You will not be able to modify these filters in the metric data explorer. For example, using "userType equals REAL_USER" will give you only data from real users, while forcing the synthetic sessions to be ignored.
    enabled boolean
    This setting is enabled (true) or disabled (false)
    metricKey string
    Metric key
    value UserSessionMetricsValue
    Defines the type of value to be extracted from the user session. When using User session counter, the number of user sessions is counted (similar to count(*) when using USQL). When using User session field value, the value of a user session field is extracted.
    dimensions string[]
    Defines the fields that are used as dimensions. A dimension is a collection of reference information about a metric data point that is of interest to your business. Dimensions are parameters like "browserFamily", "userType", "country". For example, using "userType" as a dimension allows you to split chart data based on user types.
    filters UserSessionMetricsFilters
    Defines the filters for the user session. Filters apply at the moment of extracting the data and only sessions that satisfy the filtering criteria will be used to extract the custom metrics. You will not be able to modify these filters in the metric data explorer. For example, using "userType equals REAL_USER" will give you only data from real users, while forcing the synthetic sessions to be ignored.
    enabled bool
    This setting is enabled (true) or disabled (false)
    metric_key str
    Metric key
    value UserSessionMetricsValueArgs
    Defines the type of value to be extracted from the user session. When using User session counter, the number of user sessions is counted (similar to count(*) when using USQL). When using User session field value, the value of a user session field is extracted.
    dimensions Sequence[str]
    Defines the fields that are used as dimensions. A dimension is a collection of reference information about a metric data point that is of interest to your business. Dimensions are parameters like "browserFamily", "userType", "country". For example, using "userType" as a dimension allows you to split chart data based on user types.
    filters UserSessionMetricsFiltersArgs
    Defines the filters for the user session. Filters apply at the moment of extracting the data and only sessions that satisfy the filtering criteria will be used to extract the custom metrics. You will not be able to modify these filters in the metric data explorer. For example, using "userType equals REAL_USER" will give you only data from real users, while forcing the synthetic sessions to be ignored.
    enabled Boolean
    This setting is enabled (true) or disabled (false)
    metricKey String
    Metric key
    value Property Map
    Defines the type of value to be extracted from the user session. When using User session counter, the number of user sessions is counted (similar to count(*) when using USQL). When using User session field value, the value of a user session field is extracted.
    dimensions List<String>
    Defines the fields that are used as dimensions. A dimension is a collection of reference information about a metric data point that is of interest to your business. Dimensions are parameters like "browserFamily", "userType", "country". For example, using "userType" as a dimension allows you to split chart data based on user types.
    filters Property Map
    Defines the filters for the user session. Filters apply at the moment of extracting the data and only sessions that satisfy the filtering criteria will be used to extract the custom metrics. You will not be able to modify these filters in the metric data explorer. For example, using "userType equals REAL_USER" will give you only data from real users, while forcing the synthetic sessions to be ignored.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the UserSessionMetrics resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing UserSessionMetrics Resource

    Get an existing UserSessionMetrics resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: UserSessionMetricsState, opts?: CustomResourceOptions): UserSessionMetrics
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dimensions: Optional[Sequence[str]] = None,
        enabled: Optional[bool] = None,
        filters: Optional[UserSessionMetricsFiltersArgs] = None,
        metric_key: Optional[str] = None,
        value: Optional[UserSessionMetricsValueArgs] = None) -> UserSessionMetrics
    func GetUserSessionMetrics(ctx *Context, name string, id IDInput, state *UserSessionMetricsState, opts ...ResourceOption) (*UserSessionMetrics, error)
    public static UserSessionMetrics Get(string name, Input<string> id, UserSessionMetricsState? state, CustomResourceOptions? opts = null)
    public static UserSessionMetrics get(String name, Output<String> id, UserSessionMetricsState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Dimensions List<string>
    Defines the fields that are used as dimensions. A dimension is a collection of reference information about a metric data point that is of interest to your business. Dimensions are parameters like "browserFamily", "userType", "country". For example, using "userType" as a dimension allows you to split chart data based on user types.
    Enabled bool
    This setting is enabled (true) or disabled (false)
    Filters Lbrlabs.PulumiPackage.Dynatrace.Inputs.UserSessionMetricsFilters
    Defines the filters for the user session. Filters apply at the moment of extracting the data and only sessions that satisfy the filtering criteria will be used to extract the custom metrics. You will not be able to modify these filters in the metric data explorer. For example, using "userType equals REAL_USER" will give you only data from real users, while forcing the synthetic sessions to be ignored.
    MetricKey string
    Metric key
    Value Lbrlabs.PulumiPackage.Dynatrace.Inputs.UserSessionMetricsValue
    Defines the type of value to be extracted from the user session. When using User session counter, the number of user sessions is counted (similar to count(*) when using USQL). When using User session field value, the value of a user session field is extracted.
    Dimensions []string
    Defines the fields that are used as dimensions. A dimension is a collection of reference information about a metric data point that is of interest to your business. Dimensions are parameters like "browserFamily", "userType", "country". For example, using "userType" as a dimension allows you to split chart data based on user types.
    Enabled bool
    This setting is enabled (true) or disabled (false)
    Filters UserSessionMetricsFiltersArgs
    Defines the filters for the user session. Filters apply at the moment of extracting the data and only sessions that satisfy the filtering criteria will be used to extract the custom metrics. You will not be able to modify these filters in the metric data explorer. For example, using "userType equals REAL_USER" will give you only data from real users, while forcing the synthetic sessions to be ignored.
    MetricKey string
    Metric key
    Value UserSessionMetricsValueArgs
    Defines the type of value to be extracted from the user session. When using User session counter, the number of user sessions is counted (similar to count(*) when using USQL). When using User session field value, the value of a user session field is extracted.
    dimensions List<String>
    Defines the fields that are used as dimensions. A dimension is a collection of reference information about a metric data point that is of interest to your business. Dimensions are parameters like "browserFamily", "userType", "country". For example, using "userType" as a dimension allows you to split chart data based on user types.
    enabled Boolean
    This setting is enabled (true) or disabled (false)
    filters UserSessionMetricsFilters
    Defines the filters for the user session. Filters apply at the moment of extracting the data and only sessions that satisfy the filtering criteria will be used to extract the custom metrics. You will not be able to modify these filters in the metric data explorer. For example, using "userType equals REAL_USER" will give you only data from real users, while forcing the synthetic sessions to be ignored.
    metricKey String
    Metric key
    value UserSessionMetricsValue
    Defines the type of value to be extracted from the user session. When using User session counter, the number of user sessions is counted (similar to count(*) when using USQL). When using User session field value, the value of a user session field is extracted.
    dimensions string[]
    Defines the fields that are used as dimensions. A dimension is a collection of reference information about a metric data point that is of interest to your business. Dimensions are parameters like "browserFamily", "userType", "country". For example, using "userType" as a dimension allows you to split chart data based on user types.
    enabled boolean
    This setting is enabled (true) or disabled (false)
    filters UserSessionMetricsFilters
    Defines the filters for the user session. Filters apply at the moment of extracting the data and only sessions that satisfy the filtering criteria will be used to extract the custom metrics. You will not be able to modify these filters in the metric data explorer. For example, using "userType equals REAL_USER" will give you only data from real users, while forcing the synthetic sessions to be ignored.
    metricKey string
    Metric key
    value UserSessionMetricsValue
    Defines the type of value to be extracted from the user session. When using User session counter, the number of user sessions is counted (similar to count(*) when using USQL). When using User session field value, the value of a user session field is extracted.
    dimensions Sequence[str]
    Defines the fields that are used as dimensions. A dimension is a collection of reference information about a metric data point that is of interest to your business. Dimensions are parameters like "browserFamily", "userType", "country". For example, using "userType" as a dimension allows you to split chart data based on user types.
    enabled bool
    This setting is enabled (true) or disabled (false)
    filters UserSessionMetricsFiltersArgs
    Defines the filters for the user session. Filters apply at the moment of extracting the data and only sessions that satisfy the filtering criteria will be used to extract the custom metrics. You will not be able to modify these filters in the metric data explorer. For example, using "userType equals REAL_USER" will give you only data from real users, while forcing the synthetic sessions to be ignored.
    metric_key str
    Metric key
    value UserSessionMetricsValueArgs
    Defines the type of value to be extracted from the user session. When using User session counter, the number of user sessions is counted (similar to count(*) when using USQL). When using User session field value, the value of a user session field is extracted.
    dimensions List<String>
    Defines the fields that are used as dimensions. A dimension is a collection of reference information about a metric data point that is of interest to your business. Dimensions are parameters like "browserFamily", "userType", "country". For example, using "userType" as a dimension allows you to split chart data based on user types.
    enabled Boolean
    This setting is enabled (true) or disabled (false)
    filters Property Map
    Defines the filters for the user session. Filters apply at the moment of extracting the data and only sessions that satisfy the filtering criteria will be used to extract the custom metrics. You will not be able to modify these filters in the metric data explorer. For example, using "userType equals REAL_USER" will give you only data from real users, while forcing the synthetic sessions to be ignored.
    metricKey String
    Metric key
    value Property Map
    Defines the type of value to be extracted from the user session. When using User session counter, the number of user sessions is counted (similar to count(*) when using USQL). When using User session field value, the value of a user session field is extracted.

    Supporting Types

    UserSessionMetricsFilters, UserSessionMetricsFiltersArgs

    UserSessionMetricsFiltersFilter, UserSessionMetricsFiltersFilterArgs

    FieldName string
    Operator string
    Value string
    Defines the type of value to be extracted from the user session. When using User session counter, the number of user sessions is counted (similar to count(*) when using USQL). When using User session field value, the value of a user session field is extracted.
    ValueIns List<string>
    FieldName string
    Operator string
    Value string
    Defines the type of value to be extracted from the user session. When using User session counter, the number of user sessions is counted (similar to count(*) when using USQL). When using User session field value, the value of a user session field is extracted.
    ValueIns []string
    fieldName String
    operator String
    value String
    Defines the type of value to be extracted from the user session. When using User session counter, the number of user sessions is counted (similar to count(*) when using USQL). When using User session field value, the value of a user session field is extracted.
    valueIns List<String>
    fieldName string
    operator string
    value string
    Defines the type of value to be extracted from the user session. When using User session counter, the number of user sessions is counted (similar to count(*) when using USQL). When using User session field value, the value of a user session field is extracted.
    valueIns string[]
    field_name str
    operator str
    value str
    Defines the type of value to be extracted from the user session. When using User session counter, the number of user sessions is counted (similar to count(*) when using USQL). When using User session field value, the value of a user session field is extracted.
    value_ins Sequence[str]
    fieldName String
    operator String
    value String
    Defines the type of value to be extracted from the user session. When using User session counter, the number of user sessions is counted (similar to count(*) when using USQL). When using User session field value, the value of a user session field is extracted.
    valueIns List<String>

    UserSessionMetricsValue, UserSessionMetricsValueArgs

    Type string
    Possible Values: COUNTER, FIELD
    FieldName string
    Field name
    Type string
    Possible Values: COUNTER, FIELD
    FieldName string
    Field name
    type String
    Possible Values: COUNTER, FIELD
    fieldName String
    Field name
    type string
    Possible Values: COUNTER, FIELD
    fieldName string
    Field name
    type str
    Possible Values: COUNTER, FIELD
    field_name str
    Field name
    type String
    Possible Values: COUNTER, FIELD
    fieldName String
    Field name

    Package Details

    Repository
    dynatrace lbrlabs/pulumi-dynatrace
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the dynatrace Terraform Provider.
    dynatrace logo
    Dynatrace v0.1.0 published on Wednesday, May 24, 2023 by Lbrlabs
    lbrlabs/pulumi-dynatrace