Skip to content
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.

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

HDDS-4271. Avoid logging chunk content in Ozone Insight #1466

Merged
merged 2 commits into from
Oct 5, 2020

Conversation

adoroszlai
Copy link
Contributor

What changes were proposed in this pull request?

HDDS-2660 added an insight point for the datanode dispatcher. At trace level it logs all chunk content, which can be huge and contain control characters. This PR removes chunk data from such log messages.

https://issues.apache.org/jira/browse/HDDS-4271

How was this patch tested?

Started Ozone Insight (for all 3 datanodes in separate windows):

ozone insight logs -v datanode.dispatcher -f datanode=ozone_datanode_1

Ran test:

ozone freon ockg -n1 -t1 -p warmup
ozone sh key put /vol1/bucket1/passwd /etc/passwd
ozone sh key get /vol1/bucket1/passwd /tmp/passwd
diff -q /etc/passwd /tmp/passwd

Output for ozone freon ockg -n1 -t1 -p warmup:

[DATANODE] ... [TRACE|org.apache.hadoop.ozone.container.common.impl.HddsDispatcher|OzoneProtocolMessageDispatcher] [service=DatanodeClient] [type=WriteChunk] request is received:
cmdType: WriteChunk
traceID: ""
containerID: 1
datanodeUuid: "833184d2-c6db-409a-934e-df7699b97061"
pipelineID: "d8e8bf6c-6eca-4941-a4a6-3b0b997fbf4f"
writeChunk {
  blockID {
    containerID: 1
    localID: 104959326432133120
    blockCommitSequenceId: 0
  }
  chunkData {
    chunkName: "104959326432133120_chunk_1"
    offset: 0
    len: 10240
    checksumData {
      type: CRC32
      bytesPerChecksum: 1048576
      checksums: "327275221253"
    }
  }
  data: "<redacted>"
}

[DATANODE] ... [TRACE|org.apache.hadoop.ozone.container.common.impl.HddsDispatcher|HddsDispatcher] Command WriteChunk, trace ID:
[DATANODE] ... [TRACE|org.apache.hadoop.ozone.container.common.impl.HddsDispatcher|OzoneProtocolMessageDispatcher] [service=DatanodeClient] [type=WriteChunk] request is processed. Response:
cmdType: WriteChunk
traceID: ""
result: SUCCESS
message: ""

Output for ozone sh key get /vol1/bucket1/passwd /tmp/passwd:

[DATANODE] ... [TRACE|org.apache.hadoop.ozone.container.common.impl.HddsDispatcher|OzoneProtocolMessageDispatcher] [service=DatanodeClient] [type=ReadChunk] request is received:
cmdType: ReadChunk
traceID: ""
containerID: 1
datanodeUuid: "833184d2-c6db-409a-934e-df7699b97061"
readChunk {
  blockID {
    containerID: 1
    localID: 104959326926798849
    blockCommitSequenceId: 6
  }
  chunkData {
    chunkName: "104959326926798849_chunk_1"
    offset: 0
    len: 671
    checksumData {
      type: CRC32
      bytesPerChecksum: 1048576
      checksums: "362232235315"
    }
  }
}

[DATANODE] ... [TRACE|org.apache.hadoop.ozone.container.common.impl.HddsDispatcher|HddsDispatcher] Command ReadChunk, trace ID:
[DATANODE] ... [TRACE|org.apache.hadoop.ozone.container.common.impl.HddsDispatcher|OzoneProtocolMessageDispatcher] [service=DatanodeClient] [type=ReadChunk] request is processed. Response:
cmdType: ReadChunk
traceID: ""
result: SUCCESS
readChunk {
  blockID {
    containerID: 1
    localID: 104959326926798849
    blockCommitSequenceId: 6
  }
  chunkData {
    chunkName: "104959326926798849_chunk_1"
    offset: 0
    len: 671
    checksumData {
      type: CRC32
      bytesPerChecksum: 1048576
      checksums: "362232235315"
    }
  }
  data: "<redacted>"
}

Regular CI:
https://github.com/adoroszlai/hadoop-ozone/actions/runs/282279336

@adoroszlai adoroszlai self-assigned this Oct 1, 2020
@adoroszlai adoroszlai requested a review from elek October 2, 2020 07:45
Copy link
Member

@elek elek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 Thanks for the patch @adoroszlai

My only counterargument is that it makes the debug slightly slower (and not only the TRACE but DEBUG as well).

But it should be acceptable, IMHO. When somebody enables DEBUG level, some slowness is expected.

@elek elek merged commit cfff097 into apache:master Oct 5, 2020
@adoroszlai adoroszlai deleted the HDDS-4271 branch October 5, 2020 12:13
@adoroszlai
Copy link
Contributor Author

Thanks @elek for reviewing and committing this.

My only counterargument is that it makes the debug slightly slower (and not only the TRACE but DEBUG as well).

I don't see why, as requestPreprocessor is only called in the trace branch.

https://github.com/apache/hadoop-ozone/blob/cfff0973d4567185532078daa4cd19ee8a4b04b5/hadoop-hdds/framework/src/main/java/org/apache/hadoop/hdds/server/OzoneProtocolMessageDispatcher.java#L74-L83

@elek
Copy link
Member

elek commented Oct 5, 2020

I don't see why, as requestPreprocessor is only called in the trace branch.

Ups, you are right. I missed it. In that case it will be slower (object copy) only for trace. Even more accetable ;-)

errose28 pushed a commit to errose28/ozone that referenced this pull request Oct 6, 2020
errose28 added a commit to errose28/ozone that referenced this pull request Oct 14, 2020
* master: (23 commits)
  HDDS-4122. Implement OM Delete Expired Open Key Request and Response (apache#1435)
  HDDS-4336. ContainerInfo does not persist BCSID (sequenceId) leading to failed replica reports (apache#1488)
  Remove extra serialization from getBlockID (apache#1470)
  HDDS-4262. Use ClientID and CallID from Rpc Client to detect retry requests (apache#1436)
  HDDS-4285. Read is slow due to frequent calls to UGI.getCurrentUser() and getTokens() (apache#1454)
  HDDS-4312. findbugs check succeeds despite compile error (apache#1476)
  HDDS-4311. Type-safe config design doc points to OM HA (apache#1477)
  HDDS-3814. Drop a column family through debug cli tool (apache#1083)
  HDDS-3728. Bucket space: check quotaUsageInBytes when write key and allocate block. (apache#1458)
  HDDS-4316. Upgrade to angular 1.8.0 due to CVE-2020-7676 (apache#1481)
  HDDS-4325. Incompatible return codes from Ozone getconf -confKey (apache#1485). Contributed by Doroszlai, Attila.
  HDDS-4309. Fix inconsistency in recon config keys starting with recon and not ozone (apache#1478)
  HDDS-4310: Ozone getconf broke the compatibility (apache#1475)
  HDDS-4298. Use an interface in Ozone client instead of XceiverClientManager (apache#1460)
  HDDS-4280. Document notable configurations for Recon. (apache#1448)
  HDDS-4156. add hierarchical layout to Chinese doc (apache#1368)
  HDDS-4242. Copy PrefixInfo proto to new project hadoop-ozone/interface-storage (apache#1444)
  HDDS-4264. Uniform naming conventions of Ozone Shell Options. (apache#1447)
  HDDS-4271. Avoid logging chunk content in Ozone Insight (apache#1466)
  HDDS-4299. Display Ratis version with ozone version (apache#1464)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants