org.apache.druid.server.audit.SQLAuditManagerConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of druid-server Show documentation
Druid Server
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.druid.server.audit;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import org.apache.druid.common.config.Configs;
import org.apache.druid.java.util.common.HumanReadableBytes;
import org.apache.druid.java.util.common.HumanReadableBytesRange;

/**
 */
public class SQLAuditManagerConfig implements AuditManagerConfig
{
  @JsonProperty
  private final long auditHistoryMillis;

  @JsonProperty
  private final boolean includePayloadAsDimensionInMetric;

  @JsonProperty
  @HumanReadableBytesRange(
      min = -1,
      message = "maxPayloadSizeBytes must either be -1 (for disabling the check) or a non negative number"
  )
  private final HumanReadableBytes maxPayloadSizeBytes;

  @JsonProperty
  private final boolean skipNullField;

  @JsonProperty
  private final boolean auditSystemRequests;

  @JsonCreator
  public SQLAuditManagerConfig(
      @JsonProperty("auditSystemRequests") Boolean auditSystemRequests,
      @JsonProperty("maxPayloadSizeBytes") HumanReadableBytes maxPayloadSizeBytes,
      @JsonProperty("skipNullField") Boolean skipNullField,
      @JsonProperty("auditHistoryMillis") Long auditHistoryMillis,
      @JsonProperty("includePayloadAsDimensionInMetric") Boolean includePayloadAsDimensionInMetric
  )
  {
    this.auditSystemRequests = Configs.valueOrDefault(auditSystemRequests, true);
    this.maxPayloadSizeBytes = Configs.valueOrDefault(maxPayloadSizeBytes, HumanReadableBytes.valueOf(-1));
    this.skipNullField = Configs.valueOrDefault(skipNullField, false);
    this.auditHistoryMillis = Configs.valueOrDefault(auditHistoryMillis, 7 * 24 * 60 * 60 * 1000L);
    this.includePayloadAsDimensionInMetric = Configs.valueOrDefault(includePayloadAsDimensionInMetric, false);
  }

  public long getAuditHistoryMillis()
  {
    return auditHistoryMillis;
  }

  public boolean isIncludePayloadAsDimensionInMetric()
  {
    return includePayloadAsDimensionInMetric;
  }

  @Override
  public long getMaxPayloadSizeBytes()
  {
    return maxPayloadSizeBytes.getBytes();
  }

  @Override
  public boolean isSkipNullField()
  {
    return skipNullField;
  }

  @Override
  public boolean isAuditSystemRequests()
  {
    return auditSystemRequests;
  }
}