1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. log
  5. LogTailAttachment
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi

alicloud.log.LogTailAttachment

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi

    The Logtail access service is a log collection agent provided by Log Service. You can use Logtail to collect logs from servers such as Alibaba Cloud Elastic Compute Service (ECS) instances in real time in the Log Service console. Refer to details

    This resource amis to attach one logtail configure to a machine group.

    NOTE: One logtail configure can be attached to multiple machine groups and one machine group can attach several logtail configures.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    import * as random from "@pulumi/random";
    
    const _default = new random.index.Integer("default", {
        max: 99999,
        min: 10000,
    });
    const example = new alicloud.log.Project("example", {
        projectName: `terraform-example-${_default.result}`,
        description: "terraform-example",
    });
    const exampleStore = new alicloud.log.Store("example", {
        projectName: example.projectName,
        logstoreName: "example-store",
        retentionPeriod: 3650,
        shardCount: 3,
        autoSplit: true,
        maxSplitShardCount: 60,
        appendMeta: true,
    });
    const exampleLogTailConfig = new alicloud.log.LogTailConfig("example", {
        project: example.projectName,
        logstore: exampleStore.logstoreName,
        inputType: "file",
        name: "terraform-example",
        outputType: "LogService",
        inputDetail: `  \x09{
    \x09\x09"logPath": "/logPath",
    \x09\x09"filePattern": "access.log",
    \x09\x09"logType": "json_log",
    \x09\x09"topicFormat": "default",
    \x09\x09"discardUnmatch": false,
    \x09\x09"enableRawLog": true,
    \x09\x09"fileEncoding": "gbk",
    \x09\x09"maxDepth": 10
    \x09}
    `,
    });
    const exampleMachineGroup = new alicloud.log.MachineGroup("example", {
        project: example.projectName,
        name: "terraform-example",
        identifyType: "ip",
        topic: "terraform",
        identifyLists: [
            "10.0.0.1",
            "10.0.0.2",
        ],
    });
    const exampleLogTailAttachment = new alicloud.log.LogTailAttachment("example", {
        project: example.projectName,
        logtailConfigName: exampleLogTailConfig.name,
        machineGroupName: exampleMachineGroup.name,
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    import pulumi_random as random
    
    default = random.index.Integer("default",
        max=99999,
        min=10000)
    example = alicloud.log.Project("example",
        project_name=f"terraform-example-{default['result']}",
        description="terraform-example")
    example_store = alicloud.log.Store("example",
        project_name=example.project_name,
        logstore_name="example-store",
        retention_period=3650,
        shard_count=3,
        auto_split=True,
        max_split_shard_count=60,
        append_meta=True)
    example_log_tail_config = alicloud.log.LogTailConfig("example",
        project=example.project_name,
        logstore=example_store.logstore_name,
        input_type="file",
        name="terraform-example",
        output_type="LogService",
        input_detail="""  \x09{
    \x09\x09"logPath": "/logPath",
    \x09\x09"filePattern": "access.log",
    \x09\x09"logType": "json_log",
    \x09\x09"topicFormat": "default",
    \x09\x09"discardUnmatch": false,
    \x09\x09"enableRawLog": true,
    \x09\x09"fileEncoding": "gbk",
    \x09\x09"maxDepth": 10
    \x09}
    """)
    example_machine_group = alicloud.log.MachineGroup("example",
        project=example.project_name,
        name="terraform-example",
        identify_type="ip",
        topic="terraform",
        identify_lists=[
            "10.0.0.1",
            "10.0.0.2",
        ])
    example_log_tail_attachment = alicloud.log.LogTailAttachment("example",
        project=example.project_name,
        logtail_config_name=example_log_tail_config.name,
        machine_group_name=example_machine_group.name)
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/log"
    	"github.com/pulumi/pulumi-random/sdk/v4/go/random"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := random.NewInteger(ctx, "default", &random.IntegerArgs{
    			Max: 99999,
    			Min: 10000,
    		})
    		if err != nil {
    			return err
    		}
    		example, err := log.NewProject(ctx, "example", &log.ProjectArgs{
    			ProjectName: pulumi.Sprintf("terraform-example-%v", _default.Result),
    			Description: pulumi.String("terraform-example"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleStore, err := log.NewStore(ctx, "example", &log.StoreArgs{
    			ProjectName:        example.ProjectName,
    			LogstoreName:       pulumi.String("example-store"),
    			RetentionPeriod:    pulumi.Int(3650),
    			ShardCount:         pulumi.Int(3),
    			AutoSplit:          pulumi.Bool(true),
    			MaxSplitShardCount: pulumi.Int(60),
    			AppendMeta:         pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		exampleLogTailConfig, err := log.NewLogTailConfig(ctx, "example", &log.LogTailConfigArgs{
    			Project:    example.ProjectName,
    			Logstore:   exampleStore.LogstoreName,
    			InputType:  pulumi.String("file"),
    			Name:       pulumi.String("terraform-example"),
    			OutputType: pulumi.String("LogService"),
    			InputDetail: pulumi.String(`  	{
    		"logPath": "/logPath",
    		"filePattern": "access.log",
    		"logType": "json_log",
    		"topicFormat": "default",
    		"discardUnmatch": false,
    		"enableRawLog": true,
    		"fileEncoding": "gbk",
    		"maxDepth": 10
    	}
    `),
    		})
    		if err != nil {
    			return err
    		}
    		exampleMachineGroup, err := log.NewMachineGroup(ctx, "example", &log.MachineGroupArgs{
    			Project:      example.ProjectName,
    			Name:         pulumi.String("terraform-example"),
    			IdentifyType: pulumi.String("ip"),
    			Topic:        pulumi.String("terraform"),
    			IdentifyLists: pulumi.StringArray{
    				pulumi.String("10.0.0.1"),
    				pulumi.String("10.0.0.2"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = log.NewLogTailAttachment(ctx, "example", &log.LogTailAttachmentArgs{
    			Project:           example.ProjectName,
    			LogtailConfigName: exampleLogTailConfig.Name,
    			MachineGroupName:  exampleMachineGroup.Name,
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    using Random = Pulumi.Random;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = new Random.Index.Integer("default", new()
        {
            Max = 99999,
            Min = 10000,
        });
    
        var example = new AliCloud.Log.Project("example", new()
        {
            ProjectName = $"terraform-example-{@default.Result}",
            Description = "terraform-example",
        });
    
        var exampleStore = new AliCloud.Log.Store("example", new()
        {
            ProjectName = example.ProjectName,
            LogstoreName = "example-store",
            RetentionPeriod = 3650,
            ShardCount = 3,
            AutoSplit = true,
            MaxSplitShardCount = 60,
            AppendMeta = true,
        });
    
        var exampleLogTailConfig = new AliCloud.Log.LogTailConfig("example", new()
        {
            Project = example.ProjectName,
            Logstore = exampleStore.LogstoreName,
            InputType = "file",
            Name = "terraform-example",
            OutputType = "LogService",
            InputDetail = @"  	{
    		""logPath"": ""/logPath"",
    		""filePattern"": ""access.log"",
    		""logType"": ""json_log"",
    		""topicFormat"": ""default"",
    		""discardUnmatch"": false,
    		""enableRawLog"": true,
    		""fileEncoding"": ""gbk"",
    		""maxDepth"": 10
    	}
    ",
        });
    
        var exampleMachineGroup = new AliCloud.Log.MachineGroup("example", new()
        {
            Project = example.ProjectName,
            Name = "terraform-example",
            IdentifyType = "ip",
            Topic = "terraform",
            IdentifyLists = new[]
            {
                "10.0.0.1",
                "10.0.0.2",
            },
        });
    
        var exampleLogTailAttachment = new AliCloud.Log.LogTailAttachment("example", new()
        {
            Project = example.ProjectName,
            LogtailConfigName = exampleLogTailConfig.Name,
            MachineGroupName = exampleMachineGroup.Name,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.random.integer;
    import com.pulumi.random.IntegerArgs;
    import com.pulumi.alicloud.log.Project;
    import com.pulumi.alicloud.log.ProjectArgs;
    import com.pulumi.alicloud.log.Store;
    import com.pulumi.alicloud.log.StoreArgs;
    import com.pulumi.alicloud.log.LogTailConfig;
    import com.pulumi.alicloud.log.LogTailConfigArgs;
    import com.pulumi.alicloud.log.MachineGroup;
    import com.pulumi.alicloud.log.MachineGroupArgs;
    import com.pulumi.alicloud.log.LogTailAttachment;
    import com.pulumi.alicloud.log.LogTailAttachmentArgs;
    import java.util.List;
    import java.util.ArrayList;
    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 default_ = new Integer("default", IntegerArgs.builder()
                .max(99999)
                .min(10000)
                .build());
    
            var example = new Project("example", ProjectArgs.builder()
                .projectName(String.format("terraform-example-%s", default_.result()))
                .description("terraform-example")
                .build());
    
            var exampleStore = new Store("exampleStore", StoreArgs.builder()
                .projectName(example.projectName())
                .logstoreName("example-store")
                .retentionPeriod(3650)
                .shardCount(3)
                .autoSplit(true)
                .maxSplitShardCount(60)
                .appendMeta(true)
                .build());
    
            var exampleLogTailConfig = new LogTailConfig("exampleLogTailConfig", LogTailConfigArgs.builder()
                .project(example.projectName())
                .logstore(exampleStore.logstoreName())
                .inputType("file")
                .name("terraform-example")
                .outputType("LogService")
                .inputDetail("""
      	{
    		"logPath": "/logPath",
    		"filePattern": "access.log",
    		"logType": "json_log",
    		"topicFormat": "default",
    		"discardUnmatch": false,
    		"enableRawLog": true,
    		"fileEncoding": "gbk",
    		"maxDepth": 10
    	}
                """)
                .build());
    
            var exampleMachineGroup = new MachineGroup("exampleMachineGroup", MachineGroupArgs.builder()
                .project(example.projectName())
                .name("terraform-example")
                .identifyType("ip")
                .topic("terraform")
                .identifyLists(            
                    "10.0.0.1",
                    "10.0.0.2")
                .build());
    
            var exampleLogTailAttachment = new LogTailAttachment("exampleLogTailAttachment", LogTailAttachmentArgs.builder()
                .project(example.projectName())
                .logtailConfigName(exampleLogTailConfig.name())
                .machineGroupName(exampleMachineGroup.name())
                .build());
    
        }
    }
    
    resources:
      default:
        type: random:integer
        properties:
          max: 99999
          min: 10000
      example:
        type: alicloud:log:Project
        properties:
          projectName: terraform-example-${default.result}
          description: terraform-example
      exampleStore:
        type: alicloud:log:Store
        name: example
        properties:
          projectName: ${example.projectName}
          logstoreName: example-store
          retentionPeriod: 3650
          shardCount: 3
          autoSplit: true
          maxSplitShardCount: 60
          appendMeta: true
      exampleLogTailConfig:
        type: alicloud:log:LogTailConfig
        name: example
        properties:
          project: ${example.projectName}
          logstore: ${exampleStore.logstoreName}
          inputType: file
          name: terraform-example
          outputType: LogService
          inputDetail: |2
              	{
            		"logPath": "/logPath",
            		"filePattern": "access.log",
            		"logType": "json_log",
            		"topicFormat": "default",
            		"discardUnmatch": false,
            		"enableRawLog": true,
            		"fileEncoding": "gbk",
            		"maxDepth": 10
            	}
      exampleMachineGroup:
        type: alicloud:log:MachineGroup
        name: example
        properties:
          project: ${example.projectName}
          name: terraform-example
          identifyType: ip
          topic: terraform
          identifyLists:
            - 10.0.0.1
            - 10.0.0.2
      exampleLogTailAttachment:
        type: alicloud:log:LogTailAttachment
        name: example
        properties:
          project: ${example.projectName}
          logtailConfigName: ${exampleLogTailConfig.name}
          machineGroupName: ${exampleMachineGroup.name}
    

    Create LogTailAttachment Resource

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

    Constructor syntax

    new LogTailAttachment(name: string, args: LogTailAttachmentArgs, opts?: CustomResourceOptions);
    @overload
    def LogTailAttachment(resource_name: str,
                          args: LogTailAttachmentArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def LogTailAttachment(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          logtail_config_name: Optional[str] = None,
                          machine_group_name: Optional[str] = None,
                          project: Optional[str] = None)
    func NewLogTailAttachment(ctx *Context, name string, args LogTailAttachmentArgs, opts ...ResourceOption) (*LogTailAttachment, error)
    public LogTailAttachment(string name, LogTailAttachmentArgs args, CustomResourceOptions? opts = null)
    public LogTailAttachment(String name, LogTailAttachmentArgs args)
    public LogTailAttachment(String name, LogTailAttachmentArgs args, CustomResourceOptions options)
    
    type: alicloud:log:LogTailAttachment
    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 LogTailAttachmentArgs
    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 LogTailAttachmentArgs
    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 LogTailAttachmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LogTailAttachmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LogTailAttachmentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var logTailAttachmentResource = new AliCloud.Log.LogTailAttachment("logTailAttachmentResource", new()
    {
        LogtailConfigName = "string",
        MachineGroupName = "string",
        Project = "string",
    });
    
    example, err := log.NewLogTailAttachment(ctx, "logTailAttachmentResource", &log.LogTailAttachmentArgs{
    	LogtailConfigName: pulumi.String("string"),
    	MachineGroupName:  pulumi.String("string"),
    	Project:           pulumi.String("string"),
    })
    
    var logTailAttachmentResource = new LogTailAttachment("logTailAttachmentResource", LogTailAttachmentArgs.builder()
        .logtailConfigName("string")
        .machineGroupName("string")
        .project("string")
        .build());
    
    log_tail_attachment_resource = alicloud.log.LogTailAttachment("logTailAttachmentResource",
        logtail_config_name="string",
        machine_group_name="string",
        project="string")
    
    const logTailAttachmentResource = new alicloud.log.LogTailAttachment("logTailAttachmentResource", {
        logtailConfigName: "string",
        machineGroupName: "string",
        project: "string",
    });
    
    type: alicloud:log:LogTailAttachment
    properties:
        logtailConfigName: string
        machineGroupName: string
        project: string
    

    LogTailAttachment Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The LogTailAttachment resource accepts the following input properties:

    LogtailConfigName string
    The Logtail configuration name, which is unique in the same project.
    MachineGroupName string
    The machine group name, which is unique in the same project.
    Project string
    The project name to the log store belongs.
    LogtailConfigName string
    The Logtail configuration name, which is unique in the same project.
    MachineGroupName string
    The machine group name, which is unique in the same project.
    Project string
    The project name to the log store belongs.
    logtailConfigName String
    The Logtail configuration name, which is unique in the same project.
    machineGroupName String
    The machine group name, which is unique in the same project.
    project String
    The project name to the log store belongs.
    logtailConfigName string
    The Logtail configuration name, which is unique in the same project.
    machineGroupName string
    The machine group name, which is unique in the same project.
    project string
    The project name to the log store belongs.
    logtail_config_name str
    The Logtail configuration name, which is unique in the same project.
    machine_group_name str
    The machine group name, which is unique in the same project.
    project str
    The project name to the log store belongs.
    logtailConfigName String
    The Logtail configuration name, which is unique in the same project.
    machineGroupName String
    The machine group name, which is unique in the same project.
    project String
    The project name to the log store belongs.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LogTailAttachment 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 LogTailAttachment Resource

    Get an existing LogTailAttachment 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?: LogTailAttachmentState, opts?: CustomResourceOptions): LogTailAttachment
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            logtail_config_name: Optional[str] = None,
            machine_group_name: Optional[str] = None,
            project: Optional[str] = None) -> LogTailAttachment
    func GetLogTailAttachment(ctx *Context, name string, id IDInput, state *LogTailAttachmentState, opts ...ResourceOption) (*LogTailAttachment, error)
    public static LogTailAttachment Get(string name, Input<string> id, LogTailAttachmentState? state, CustomResourceOptions? opts = null)
    public static LogTailAttachment get(String name, Output<String> id, LogTailAttachmentState 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:
    LogtailConfigName string
    The Logtail configuration name, which is unique in the same project.
    MachineGroupName string
    The machine group name, which is unique in the same project.
    Project string
    The project name to the log store belongs.
    LogtailConfigName string
    The Logtail configuration name, which is unique in the same project.
    MachineGroupName string
    The machine group name, which is unique in the same project.
    Project string
    The project name to the log store belongs.
    logtailConfigName String
    The Logtail configuration name, which is unique in the same project.
    machineGroupName String
    The machine group name, which is unique in the same project.
    project String
    The project name to the log store belongs.
    logtailConfigName string
    The Logtail configuration name, which is unique in the same project.
    machineGroupName string
    The machine group name, which is unique in the same project.
    project string
    The project name to the log store belongs.
    logtail_config_name str
    The Logtail configuration name, which is unique in the same project.
    machine_group_name str
    The machine group name, which is unique in the same project.
    project str
    The project name to the log store belongs.
    logtailConfigName String
    The Logtail configuration name, which is unique in the same project.
    machineGroupName String
    The machine group name, which is unique in the same project.
    project String
    The project name to the log store belongs.

    Import

    Logtial to machine group can be imported using the id, e.g.

    $ pulumi import alicloud:log/logTailAttachment:LogTailAttachment example tf-log:tf-log-config:tf-log-machine-group
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.66.0 published on Friday, Nov 15, 2024 by Pulumi