LogtailConfig
- Implements: ILogtailConfig
This class encapsulates and extends the ROS resource type ALIYUN::SLS::LogtailConfig, which is used to configure Logtail properties for data collection.
Initializers
import com.aliyun.ros.cdk.sls.LogtailConfig;
LogtailConfig.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.logstoreName(java.lang.String)
.logstoreName(IResolvable)
.logtailConfigName(java.lang.String)
.logtailConfigName(IResolvable)
.projectName(java.lang.String)
.projectName(IResolvable)
// .cloneFrom(IResolvable)
// .cloneFrom(CloneFromProperty)
// .rawConfigData(IResolvable)
// .rawConfigData(java.util.Map<java.lang.String, java.lang.Object>)
.build();
| Name | Type | Description |
|---|---|---|
scope | com.aliyun.ros.cdk.core.Construct | No description. |
id | java.lang.String | No description. |
enableResourcePropertyConstraint | java.lang.Boolean | No description. |
logstoreName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property logstoreName: Logstore name: 1. |
logtailConfigName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property logtailConfigName: Logtail config name: 1. |
projectName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property projectName: Project name: 1. |
cloneFrom | com.aliyun.ros.cdk.core.IResolvable OR CloneFromProperty | Property cloneFrom: Clone logtail config data from existing logtail config. |
rawConfigData | com.aliyun.ros.cdk.core.IResolvable OR java.util.Map | Property rawConfigData: The format is the same as the response of SLS API GetConfig. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
logstoreNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property logstoreName: Logstore name: 1.
Only supports lowercase letters, numbers, hyphens (-) and underscores (_). 2. Must start and end with lowercase letters and numbers. 3. The name length is 3-63 characters.
logtailConfigNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property logtailConfigName: Logtail config name: 1.
Only supports lowercase letters, numbers, hyphens (-) and underscores (_). 2. Must start and end with lowercase letters and numbers. 3. The name length is 3-63 characters.
projectNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property projectName: Project name: 1.
Only supports lowercase letters, numbers, hyphens (-) and underscores (_). 2. Must start and end with lowercase letters and numbers. 3. The name length is 3-63 characters.
cloneFromOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR CloneFromProperty
Property cloneFrom: Clone logtail config data from existing logtail config.
Either CloneFrom or RawConfigData must be specified. If CloneFrom and RawConfigData are both specified, logtail config data will be merged from both with RawConfigData first.
rawConfigDataOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map
Property rawConfigData: The format is the same as the response of SLS API GetConfig.
Either CloneFrom or RawConfigData must be specified. If CloneFrom and RawConfigData are both specified, logtail config data will be merged from both with RawConfigData first. configName, outputType, outputDetail in data will be ignored.For example: { "configName": "test-logtail-config", "createTime": 1574843554, "inputDetail": { "acceptNoEnoughKeys": false, "adjustTimezone": false, "advanced": { "force_multiconfig": false }, "autoExtend": true, "delayAlarmBytes": 0, "delaySkipBytes": 0, "discardNonUtf8": false, "discardUnmatch": false, "dockerExcludeEnv": {}, "dockerExcludeLabel": {}, "dockerFile": false, "dockerIncludeEnv": {}, "dockerIncludeLabel": {}, "enableRawLog": false, "enableTag": false, "fileEncoding": "utf8", "filePattern": "test.log*", "filterKey": [], "filterRegex": [], "key": [ "time", "logger", "level", "request_id", "user_id", "region_id", "content" ], "localStorage": true, "logPath": "/var/log/test", "logTimezone": "", "logType": "delimiter_log", "maxDepth": 100, "maxSendRate": -1, "mergeType": "topic", "preserve": true, "preserveDepth": 1, "priority": 0, "quote": "", "sendRateExpire": 0, "sensitive_keys": [], "separator": ",,,", "shardHashKey": [], "tailExisted": false, "timeFormat": "", "timeKey": "", "topicFormat": "none" }, "inputType": "file", "lastModifyTime": 1574843554, "logSample": "2019-11-27 10:48:23,160,,,MAIN,,,INFO,,,98DCC51D-BE5D-49C7-B3FD-37B2BAEFB296,,,123456789,,,cn-hangzhou,,,this is a simple test.", "outputDetail": { "endpoint": "cn-hangzhou-intranet.log.aliyuncs.com", "logstoreName": "test-logstore", "region": "cn-hangzhou" }, "outputType": "LogService" }
Methods
| Name | Description |
|---|---|
toString | Returns a string representation of this construct. |
synthesize | Allows this construct to emit artifacts into the cloud assembly during synthesis. |
addCondition | No description. |
addCount | No description. |
addDependency | No description. |
addResourceDesc | No description. |
applyRemovalPolicy | No description. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | No description. |
getAtt | No description. |
setMetadata | No description. |
toString
public java.lang.String toString()
Returns a string representation of this construct.
synthesize
public void synthesize(ISynthesisSession session)
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.sls.LogtailConfig;
LogtailConfig.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
ref | java.lang.String | No description. |
stack | com.aliyun.ros.cdk.core.Stack | The stack in which this resource is defined. |
resource | com.aliyun.ros.cdk.core.RosResource | No description. |
attrAppliedMachineGroups | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute AppliedMachineGroups: Applied machine groups. |
attrEndpoint | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Endpoint: Endpoint address. |
attrLogtailConfigName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute LogtailConfigName: Logtail config name. |
props | LogtailConfigProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.ros.cdk.core.IResourceEnvironment
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
refRequired
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrAppliedMachineGroupsRequired
public java.lang.Object getAttrAppliedMachineGroups();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute AppliedMachineGroups: Applied machine groups.
attrEndpointRequired
public java.lang.Object getAttrEndpoint();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Endpoint: Endpoint address.
attrLogtailConfigNameRequired
public java.lang.Object getAttrLogtailConfigName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute LogtailConfigName: Logtail config name.
propsRequired
public LogtailConfigProps getProps();
- Type: LogtailConfigProps