com.facebook.buck.logd.client

Class LogdClient

java.lang.Object

com.facebook.buck.logd.client.LogdClient

All Implemented Interfaces:

LogDaemonClient

public class LogdClient
extends Object
implements LogDaemonClient

Given a host and port number, this client is used to make a connection and stream logs to logD server

Constructor Summary

Constructors

Constructor and Description
LogdClient(io.grpc.ManagedChannelBuilder<?> channelBuilder, StreamObserverFactory streamObserverFactory) Constructs a LogdClient with the provided channel
LogdClient(String host, int port) Constructs a LogdClient with the provided hostname and port number.
LogdClient(String host, int port, StreamObserverFactory streamObserverFactory) Constructs a LogdClient with the provided hostname, port number and an implementation of StreamObserverFactory.

Method Summary

Modifier and Type	Method and Description
int	createLogFile(String path, com.facebook.buck.logd.proto.LogType logType) Client calls this method to request LogD to create a log file in file-system and/or storage.
io.grpc.stub.StreamObserver<com.facebook.buck.logd.proto.LogMessage>	openLog(int logFileId, String logContent) Client calls this method to acquire a StreamObserver object which listens for incoming logs.
void	shutdown() close all existing channels to logD server

Methods inherited from class java.lang.Object

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

Constructor Detail

LogdClient

public LogdClient(String host,
                  int port)

Constructs a LogdClient with the provided hostname and port number.

Parameters:

host - host name

port - port number

LogdClient

public LogdClient(String host,
                  int port,
                  StreamObserverFactory streamObserverFactory)

Constructs a LogdClient with the provided hostname, port number and an implementation of StreamObserverFactory.

Parameters:

host - host name

port - port number

streamObserverFactory - an implementation of StreamObserverFactory

LogdClient

public LogdClient(io.grpc.ManagedChannelBuilder<?> channelBuilder,
                  StreamObserverFactory streamObserverFactory)

Constructs a LogdClient with the provided channel

Parameters:

channelBuilder - a channel to LogD server

Method Detail

shutdown

public void shutdown()

Description copied from interface: LogDaemonClient

close all existing channels to logD server

Specified by:

shutdown in interface LogDaemonClient

createLogFile

public int createLogFile(String path,
                         com.facebook.buck.logd.proto.LogType logType)
                  throws LogDaemonException

Description copied from interface: LogDaemonClient

Client calls this method to request LogD to create a log file in file-system and/or storage.

Specified by:

createLogFile in interface LogDaemonClient

Returns:

a file identifier logFileId corresponding to the created file by LogD server

Throws:

LogDaemonException

openLog

public io.grpc.stub.StreamObserver<com.facebook.buck.logd.proto.LogMessage> openLog(int logFileId,
                                                                                    String logContent)
                                                                             throws LogDaemonException

Description copied from interface: LogDaemonClient

Client calls this method to acquire a StreamObserver object which listens for incoming logs. Upon receiving the StreamObserver, client uses it to stream log messages to locations identified by logFileId

Specified by:

openLog in interface LogDaemonClient

Parameters:

logFileId - log file identifier generated by LogD server

logContent - log message to be streamed to LogD

Returns:

a StreamObserver which observers and processes incoming logs from client

Throws:

LogDaemonException