Skip to content

Support custom logging driver #1242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Support custom logging driver #1242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 62 additions & 17 deletions docker-java-api/src/main/java/com/github/dockerjava/api/model/LogConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
package com.github.dockerjava.api.model;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonValue;
import com.fasterxml.jackson.annotation.JsonSetter;

import javax.annotation.CheckForNull;
import java.io.Serializable;
import java.util.Map;

Expand All @@ -21,44 +20,102 @@
public class LogConfig implements Serializable {
private static final long serialVersionUID = 1L;

@JsonProperty("Type")
public static final String NONE = "none";
public static final String DEFAULT = "json-file";
public static final String ETWLOGS = "etwlogs";
public static final String JSON_FILE = "json-file";
public static final String SYSLOG = "syslog";
public static final String JOURNALD = "journald";
public static final String GELF = "gelf";
public static final String FLUENTD = "fluentd";
public static final String AWSLOGS = "awslogs";
public static final String DB = "db"; // Synology specific driver
public static final String SPLUNK = "splunk";
public static final String GCPLOGS = "gcplogs";

@Deprecated
public LoggingType type = null;
private String loggingType = null;

@JsonProperty("Config")
public Map<String, String> config;

@Deprecated
public LogConfig(LoggingType type, Map<String, String> config) {
this.type = type;
this.config = config;
this.type = type;
}

@Deprecated
public LogConfig(LoggingType type) {
this(type, null);
}

public LogConfig(String type, Map<String, String> config) {
this.config = config;
this.withLoggingType(type);
}

public LogConfig(String type) {
this(type, null);
}

public LogConfig() {
}

@Deprecated
@JsonIgnore
public LoggingType getType() {
return type;
}

@Deprecated
@JsonIgnore
public LogConfig setType(LoggingType type) {
this.type = type;
return this;
}

@JsonGetter("Type")
public String getLoggingType() {
if (type != null) {
return type.getType();
}

return loggingType;
}

@JsonSetter("Type")
public LogConfig withLoggingType(String loggingType) {
for (LoggingType enumType : LoggingType.values()) {
if (enumType.getType().equals(loggingType)) {
this.type = enumType;
}
}

this.loggingType = loggingType;
return this;
}

@JsonIgnore
public Map<String, String> getConfig() {
return config;
}

@JsonIgnore
@Deprecated
public LogConfig setConfig(Map<String, String> config) {
this.config = config;
return this;
}

@JsonIgnore
public LogConfig withConfig(Map<String, String> config) {
this.config = config;
return this;
}

@Deprecated
public enum LoggingType {
NONE("none"),
DEFAULT("json-file"),
Expand All @@ -79,22 +136,10 @@ public enum LoggingType {
this.type = type;
}

@JsonValue
public String getType() {
return type;
}

@JsonCreator
@CheckForNull
public static LoggingType fromValue(String text) {
for (LoggingType b : LoggingType.values()) {
if (String.valueOf(b.type).equals(text)) {
return b;
}
}
return null;
}

@Override
public String toString() {
return String.valueOf(type);
Expand Down
20 changes: 15 additions & 5 deletions docker-java/src/test/java/com/github/dockerjava/cmd/CreateContainerCmdIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -862,18 +862,28 @@ public void createContainerWithLogConfig() throws DockerException {

LogConfig logConfig = new LogConfig(LogConfig.LoggingType.NONE, null);
CreateContainerResponse container = dockerRule.getClient().createContainerCmd(DEFAULT_IMAGE)
.withHostConfig(newHostConfig()
.withLogConfig(logConfig))
.withHostConfig(newHostConfig().withLogConfig(logConfig))
.exec();

LOG.info("Created container {}", container.toString());

assertThat(container.getId(), not(isEmptyString()));

InspectContainerResponse inspectContainerResponse = dockerRule.getClient().inspectContainerCmd(container.getId()).exec();
assertThat(inspectContainerResponse.getHostConfig().getLogConfig().type, is(LogConfig.LoggingType.NONE));
assertThat(inspectContainerResponse.getHostConfig().getLogConfig().getLoggingType(), equalTo(LogConfig.NONE));
}

// null becomes empty string
assertThat(inspectContainerResponse.getHostConfig().getLogConfig().type, is(logConfig.type));
@Test
public void createContainerWithCustomLogConfig() throws DockerException {
CreateContainerResponse container = dockerRule.getClient().createContainerCmd(DEFAULT_IMAGE)
.withHostConfig(new HostConfig().withLogConfig(new LogConfig().withLoggingType("json-file")))
.exec();

LOG.info("Created container {}", container.toString());
assertThat(container.getId(), not(isEmptyString()));

InspectContainerResponse inspectContainerResponse = dockerRule.getClient().inspectContainerCmd(container.getId()).exec();
assertThat(inspectContainerResponse.getHostConfig().getLogConfig().getLoggingType(), equalTo(LogConfig.JSON_FILE));
}

/**
Expand Down