[ 
https://issues.apache.org/jira/browse/HDFS-8284?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14527214#comment-14527214
 ] 

Colin Patrick McCabe commented on HDFS-8284:
--------------------------------------------

Thanks, [~iwasakims].

{code}
2328    <property>
2329      <name>dfs.htrace.spanreceiver.classes</name>
2330      <value></value>
2331      <description>
2332        A comma separated list of the fully-qualified class name of classes 
2333        implementing SpanReceiver. The tracing system works by collecting 
2334        information in structs called 'Spans'. It is up to you to choose 
2335        how you want to receive this information by implementing the 
2336        SpanReceiver interface.
2337      </description>
2338    </property>
{code}

I think this description should be something more like "The HTrace SpanReceiver 
to use for the NameNode, DataNode, and JournalNode."  We shouldn't try to 
explain what spans are... let's just link to the HTrace documentation rather 
than repeating it here.

{code}
2339    
2340    <property>
2341      <name>dfs.client.htrace.spanreceiver.classes</name>
2342      <value></value>
2343      <description>
2344        A comma separated list of the fully-qualified class name of classes 
2345        implementing SpanReceiver. This property is used by DFSClient
2346        for tracing started internally.
2347      </description>
2348    </property>
{code}
I think this description should be something more like "The HTrace SpanReceiver 
for the HDFS client.  You do not need to enable this if your client has been 
modified to use HTrace."  Again, just provide a reference to the HTrace docs.

{code}
213     ### Starting tracing spans by configuration for HDFS client
214     
215     You can start tracing spans by setting configuration for HDFS client.
216     This is useful for tracing programs where you don't have access to the 
source code.
{code}
How about, "The DFSClient can enable tracing internally.  This allows you to 
use HTrace with your client without modifying the client source code."

> Add usage of tracing originated in DFSClient to doc
> ---------------------------------------------------
>
>                 Key: HDFS-8284
>                 URL: https://issues.apache.org/jira/browse/HDFS-8284
>             Project: Hadoop HDFS
>          Issue Type: Improvement
>          Components: documentation
>            Reporter: Masatake Iwasaki
>            Assignee: Masatake Iwasaki
>         Attachments: HDFS-8284.001.patch
>
>
> Tracing originated in DFSClient uses configuration keys prefixed with 
> "dfs.client.htrace" after HDFS-8213. Server side tracing uses conf keys 
> prefixed with "dfs.htrace".



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to