com.aliyun.openservices.aliyun.log.producer

类 LogProducer

java.lang.Object

com.aliyun.openservices.aliyun.log.producer.LogProducer

所有已实现的接口:

Producer

public class LogProducer
extends Object
implements Producer

A client that send logs to the Aliyun Log Service.

The producer is thread safe and sharing a single producer instance across threads will generally be faster than having multiple instances.

构造器概要

构造器

构造器和说明
LogProducer(ProducerConfig producerConfig) Start up a LogProducer instance.

方法概要

限定符和类型	方法和说明
int	availableMemoryInBytes() See availableMemoryInBytes()
void	close() Close this producer.
void	close(long timeoutMs) This method waits up to timeoutMs for the producer to handle all submitted logs and close all background threads.
int	getBatchCount() See getBatchCount()
ProducerConfig	getProducerConfig() See getProducerConfig()
void	putProjectConfig(ProjectConfig projectConfig) Add or update a project config.
void	removeProjectConfig(ProjectConfig projectConfig) Remove a project config.
com.google.common.util.concurrent.ListenableFuture<Result>	send(String project, String logStore, List<com.aliyun.openservices.log.common.LogItem> logItems) Send a list of logs asynchronously.
com.google.common.util.concurrent.ListenableFuture<Result>	send(String project, String logStore, List<com.aliyun.openservices.log.common.LogItem> logItems, Callback callback) Send a list of logs asynchronously.
com.google.common.util.concurrent.ListenableFuture<Result>	send(String project, String logStore, com.aliyun.openservices.log.common.LogItem logItem) Send a log asynchronously.
com.google.common.util.concurrent.ListenableFuture<Result>	send(String project, String logStore, com.aliyun.openservices.log.common.LogItem logItem, Callback callback) Send a log asynchronously.
com.google.common.util.concurrent.ListenableFuture<Result>	send(String project, String logStore, String topic, String source, List<com.aliyun.openservices.log.common.LogItem> logItems) Send a list of logs asynchronously.
com.google.common.util.concurrent.ListenableFuture<Result>	send(String project, String logStore, String topic, String source, List<com.aliyun.openservices.log.common.LogItem> logItems, Callback callback) Send a list of logs asynchronously.
com.google.common.util.concurrent.ListenableFuture<Result>	send(String project, String logStore, String topic, String source, com.aliyun.openservices.log.common.LogItem logItem) Send a log asynchronously.
com.google.common.util.concurrent.ListenableFuture<Result>	send(String project, String logStore, String topic, String source, com.aliyun.openservices.log.common.LogItem logItem, Callback callback) Send a log asynchronously.
com.google.common.util.concurrent.ListenableFuture<Result>	send(String project, String logStore, String topic, String source, String shardHash, List<com.aliyun.openservices.log.common.LogItem> logItems) Send a list of logs asynchronously.
com.google.common.util.concurrent.ListenableFuture<Result>	send(String project, String logStore, String topic, String source, String shardHash, List<com.aliyun.openservices.log.common.LogItem> logItems, Callback callback) Asynchronously send a list of logs and invoke the provided callback when the send has been acknowledged.
com.google.common.util.concurrent.ListenableFuture<Result>	send(String project, String logStore, String topic, String source, String shardHash, com.aliyun.openservices.log.common.LogItem logItem) Send a log asynchronously.
com.google.common.util.concurrent.ListenableFuture<Result>	send(String project, String logStore, String topic, String source, String shardHash, com.aliyun.openservices.log.common.LogItem logItem, Callback callback) Send a log asynchronously.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

LogProducer

public LogProducer(ProducerConfig producerConfig)

Start up a LogProducer instance.

Since this creates a series of threads and data structures, it is fairly expensive. Avoid creating more than one per application.

All methods in LogProducer are thread-safe.

参数:

producerConfig - Configuration for the LogProducer. See the docs for that class for details.

另请参阅:

ProducerConfig

方法详细资料

send

public com.google.common.util.concurrent.ListenableFuture<Result> send(String project,
                                                                       String logStore,
                                                                       com.aliyun.openservices.log.common.LogItem logItem)
                                                                throws InterruptedException,
                                                                       ProducerException

Send a log asynchronously. Equivalent to send(project, logStore, "", "", "", logItem, null). See send(String, String, String, String, String, LogItem, Callback) for details.

指定者:

send 在接口中 Producer

抛出:

InterruptedException

ProducerException

send

public com.google.common.util.concurrent.ListenableFuture<Result> send(String project,
                                                                       String logStore,
                                                                       List<com.aliyun.openservices.log.common.LogItem> logItems)
                                                                throws InterruptedException,
                                                                       ProducerException

Send a list of logs asynchronously. Equivalent to send(project, logStore, "", "", "", logItems, null). See send(String, String, String, String, String, List, Callback) for details.

指定者:

send 在接口中 Producer

抛出:

InterruptedException

ProducerException

send

public com.google.common.util.concurrent.ListenableFuture<Result> send(String project,
                                                                       String logStore,
                                                                       String topic,
                                                                       String source,
                                                                       com.aliyun.openservices.log.common.LogItem logItem)
                                                                throws InterruptedException,
                                                                       ProducerException

Send a log asynchronously. Equivalent to send(project, logStore, topic, source, "", logItem, null). See send(String, String, String, String, String, LogItem, Callback) for details.

指定者:

send 在接口中 Producer

抛出:

InterruptedException

ProducerException

send

public com.google.common.util.concurrent.ListenableFuture<Result> send(String project,
                                                                       String logStore,
                                                                       String topic,
                                                                       String source,
                                                                       List<com.aliyun.openservices.log.common.LogItem> logItems)
                                                                throws InterruptedException,
                                                                       ProducerException

Send a list of logs asynchronously. Equivalent to send(project, logStore, topic, source, "", logItems, null). See send(String, String, String, String, String, List, Callback) for details.

指定者:

send 在接口中 Producer

抛出:

InterruptedException

ProducerException

send

public com.google.common.util.concurrent.ListenableFuture<Result> send(String project,
                                                                       String logStore,
                                                                       String topic,
                                                                       String source,
                                                                       String shardHash,
                                                                       com.aliyun.openservices.log.common.LogItem logItem)
                                                                throws InterruptedException,
                                                                       ProducerException

Send a log asynchronously. Equivalent to send(project, logStore, topic, source, shardHash, logItem, null). See send(String, String, String, String, String, LogItem, Callback) for details.

指定者:

send 在接口中 Producer

抛出:

InterruptedException

ProducerException

send

public com.google.common.util.concurrent.ListenableFuture<Result> send(String project,
                                                                       String logStore,
                                                                       String topic,
                                                                       String source,
                                                                       String shardHash,
                                                                       List<com.aliyun.openservices.log.common.LogItem> logItems)
                                                                throws InterruptedException,
                                                                       ProducerException

Send a list of logs asynchronously. Equivalent to send(project, logStore, topic, source, shardHash, logItems, null). See send(String, String, String, String, String, List, Callback) for details.

指定者:

send 在接口中 Producer

抛出:

InterruptedException

ProducerException

send

public com.google.common.util.concurrent.ListenableFuture<Result> send(String project,
                                                                       String logStore,
                                                                       com.aliyun.openservices.log.common.LogItem logItem,
                                                                       Callback callback)
                                                                throws InterruptedException,
                                                                       ProducerException

Send a log asynchronously. Equivalent to send(project, logStore, "", "", "", logItem, callback). See send(String, String, String, String, String, LogItem, Callback) for details.

指定者:

send 在接口中 Producer

抛出:

InterruptedException

ProducerException

send

public com.google.common.util.concurrent.ListenableFuture<Result> send(String project,
                                                                       String logStore,
                                                                       List<com.aliyun.openservices.log.common.LogItem> logItems,
                                                                       Callback callback)
                                                                throws InterruptedException,
                                                                       ProducerException

Send a list of logs asynchronously. Equivalent to send(project, logStore, "", "", "", logItems, callback). See send(String, String, String, String, String, List, Callback) for details.

指定者:

send 在接口中 Producer

抛出:

InterruptedException

ProducerException

send

public com.google.common.util.concurrent.ListenableFuture<Result> send(String project,
                                                                       String logStore,
                                                                       String topic,
                                                                       String source,
                                                                       com.aliyun.openservices.log.common.LogItem logItem,
                                                                       Callback callback)
                                                                throws InterruptedException,
                                                                       ProducerException

Send a log asynchronously. Equivalent to send(project, logStore, topic, source, "", logItem, callback). See send(String, String, String, String, String, LogItem, Callback) for details.

指定者:

send 在接口中 Producer

抛出:

InterruptedException

ProducerException

send

public com.google.common.util.concurrent.ListenableFuture<Result> send(String project,
                                                                       String logStore,
                                                                       String topic,
                                                                       String source,
                                                                       List<com.aliyun.openservices.log.common.LogItem> logItems,
                                                                       Callback callback)
                                                                throws InterruptedException,
                                                                       ProducerException

Send a list of logs asynchronously. Equivalent to send(project, logStore, topic, source, "", logItems, callback). See send(String, String, String, String, String, List, Callback) for details.

指定者:

send 在接口中 Producer

抛出:

InterruptedException

ProducerException

send

public com.google.common.util.concurrent.ListenableFuture<Result> send(String project,
                                                                       String logStore,
                                                                       String topic,
                                                                       String source,
                                                                       String shardHash,
                                                                       com.aliyun.openservices.log.common.LogItem logItem,
                                                                       Callback callback)
                                                                throws InterruptedException,
                                                                       ProducerException

Send a log asynchronously. It will convert the log to a log list which only contains one log, and then invoke send(project, logStore, topic, source, logItems, logItem, callback). See send(String, String, String, String, String, List, Callback) for details.

指定者:

send 在接口中 Producer

抛出:

InterruptedException

ProducerException

send

public com.google.common.util.concurrent.ListenableFuture<Result> send(String project,
                                                                       String logStore,
                                                                       String topic,
                                                                       String source,
                                                                       String shardHash,
                                                                       List<com.aliyun.openservices.log.common.LogItem> logItems,
                                                                       Callback callback)
                                                                throws InterruptedException,
                                                                       ProducerException

Asynchronously send a list of logs and invoke the provided callback when the send has been acknowledged.

The send is asynchronous and this method will return immediately once the logs has been stored in the buffer of logs waiting to be sent. This allows sending many logs in parallel without blocking to wait for the response after each one.

A ListenableFuture is returned that can be used to retrieve the result, either by polling or by registering a callback.

The return value can be disregarded if you do not wish to process the result. Under the covers, the producer will automatically re-attempt sends in case of transient errors (including throttling). A failed result is generally returned only if an irrecoverable error is detected (e.g. trying to send to a project or logstore that doesn't exist).

Note that callbacks will generally execute in the background batch handler thread of the producer and so should be reasonably fast or they will delay the sending of logs from other threads. If you want to execute blocking or computationally expensive callbacks it is recommended to use your own Executor in the callback body to parallelize processing.

指定者:

send 在接口中 Producer

参数:

project - The target project.

logStore - The target logstore.

topic - The topic of the logs.

source - The source of the logs.

shardHash - The shardHash of the logs, used to write this logs to a specific shard in the logStore.

logItems - The logs to send.

callback - A user-supplied callback to execute when the logs has been acknowledged by the server (null indicates no callback).

抛出:

IllegalArgumentException - If input does not meet stated constraints.

IllegalStateException - If you want to send logs after the producer was closed.

InterruptedException - If the thread is interrupted while blocked.

TimeoutException - If the time taken for allocating memory for the logs has surpassed.

MaxBatchCountExceedException - If the log list size exceeds ProducerConfig.getBatchCountThreshold().

LogSizeTooLargeException - If the total size of the logs exceeds ProducerConfig.getTotalSizeInBytes() or ProducerConfig.getBatchSizeThresholdInBytes().

ProducerException - If a producer related exception occurs that does not belong to the above exceptions.

close

public void close()
           throws InterruptedException,
                  ProducerException

Close this producer. This method blocks until all previously submitted logs have been handled and all background threads are stopped. This method is equivalent to close(Long.MAX_VALUE).

If close() is called from Callback, a warning message will be logged and it will skip join batch handler thread. We do this because the sender thread would otherwise try to join itself and block forever.

指定者:

close 在接口中 Producer

抛出:

InterruptedException - If the thread is interrupted while blocked.

ProducerException - If the background threads is still alive.

close

public void close(long timeoutMs)
           throws InterruptedException,
                  ProducerException

This method waits up to timeoutMs for the producer to handle all submitted logs and close all background threads.

If this method is called from Callback, a warning message will be logged and it will skip join batch handler thread. We do this because the sender thread would otherwise try to join itself and block forever.

指定者:

close 在接口中 Producer

参数:

timeoutMs - The maximum time to wait for producer to handle all submitted logs and close all background threads. The value should be non-negative. Specifying a timeout of zero means do not wait for pending send requests to complete.

抛出:

IllegalArgumentException - If the timeoutMs is negative.

InterruptedException - If the thread is interrupted while blocked.

ProducerException - If the producer is unable to handle all submitted logs or close all background threads.

getProducerConfig

public ProducerConfig getProducerConfig()

从接口复制的说明: Producer

See getProducerConfig()

指定者:

getProducerConfig 在接口中 Producer

返回:

Producer config of the producer instance.

getBatchCount

public int getBatchCount()

从接口复制的说明: Producer

See getBatchCount()

指定者:

getBatchCount 在接口中 Producer

返回:

Uncompleted batch count in the producer.

availableMemoryInBytes

public int availableMemoryInBytes()

从接口复制的说明: Producer

See availableMemoryInBytes()

指定者:

availableMemoryInBytes 在接口中 Producer

返回:

Available memory size in the producer.

putProjectConfig

public void putProjectConfig(ProjectConfig projectConfig)

Add or update a project config.

指定者:

putProjectConfig 在接口中 Producer

removeProjectConfig

public void removeProjectConfig(ProjectConfig projectConfig)

Remove a project config.

指定者:

removeProjectConfig 在接口中 Producer