英語によるhadoop系メーリングリストへのバグレポート提出ガイド

hadoop アドベントカレンダー 2011、1日目及びその他空いているところ全部を担当する @ です。

27日は誰もいないようなのでこれを27日とします。

id:showyou さんの担当でした。28日目とします。showyou さんすいません

基本

テンプレ的に書くとこんな感じ。

「本来は……であるべきだが、実際にはこうなっている」

前半は should を使い、but/in fact/however/while などを使って逆接でつないで次の文を書く。


以下の項目があるとレスポンスしやすい。

項目名 内容
概要 数行程度で何が起きたか書く
症状 特に、ログに例外が吐かれてたら必ず貼り付けること
直前にどんな作業をしていたか 何か特殊な作業を行っていたら、その手順を書く
再現性の有無 そのまんま
再現方法(わかっていれば) そのまんま

可能なら、該当 conf ファイルと、エラー発生直前数百行ぐらいのログを圧縮して添付する。
第一報でのログは、grep -v で DEBUG と INFO の行を除いてもいいかもしれない。
自分の場合は grep -v "DEBUG\|INFO" -A 10 -B 10 などで出力している。
お好みで。


「もしかしたら自分の設定ミスだったり、勘違いかも」などと思うと、そういう気持ちを文章に書いてしまうが少なくとも hadoop コミュニティの ML ではそういうことを気にする必要は一切ない。

「本来こうあるべきところが、こういう事象が起きました。バグです」

とだけ簡潔に報告すればいい。


英語のポイント

時制

バグ報告などでは特に重要なので文法の本などで復習しておくといい。

書き出し

1行目は Hi there, とか Hi folks, で十分。
誰かに返信もらった後の最初の返信は Hi shiumachi, みたいに Hi + ファーストネーム or ハンドルネームで大丈夫。
その後の返信は shiumachi, みたいに Hi を抜いたりもするがご自由に。

結び

Thanks, とか Regards, あたりが一般的。
Sincerely, は個人的にこれで来るとびびる。(かしこまったイメージ)
なぜか中国系の人は Sincerely, を使うことが多い気がする。偏見かもしれないが。
ちなみに、返信もらうときに HTH とか書く人がいるが、これは Hope this helps つまり「お役に立てばいいのですが」の意。
最後に署名を忘れずに。
自分の場合だとこんな感じ。

Regards,
shiumachi

頻出英単語・イディオム

should

「~するはず」という意味。日本の英語の授業で習うような「~すべき」という意味ではあまり使われない。

Hopefully it should work for your case.


自分では試してないけどドキュメント見る限りではそうじゃない? みたいなケースのときも should で返すことがある。

For testing and experimentation it should be fine, but no real guarantees beyond that.

might

「かもしれない」などの意味で使う。may との明確な意味分けが難しいが、自分の感覚ではバグレポート内で使うのは might の方が多い気がする。
状況について見解を述べたい場合は、it might ~ みたいな感じで言えばいいと思う。
あまり確度が高くない場合はこれで OK。

You might be suffering from HADOOP-7822.

I think there might be more details that
it will print that will be helpful.

could

こっちは「あり得る」ぐらいの意味合い。

I agree Hama (and BSP model) could be a good option, plus Hama also
supports MR nextgen now.

I guess it could be better to decommission and recommission+balance
if you can afford the time.

probably

よく9割以上の確度、とかいう説明がされるが、個人的にはもうちょい強い意味合いを持ってる気がする。

You are probably right that the number of reducers is rather =
small, given the amount of data that is being reduced.

I think

日本語の「思う」はあまり意味が強くないが、I think と書くとかなり不明瞭なイメージ。先述の might の例文のように、確信は持ってないけど私はこう思う、ぐらいの意味合い。

I guess

think よりもさらに自信がないイメージ。あれこれ考えていて、そのうちの推測の一つとしてこんな風に思うんだけど、ぐらいのニュアンス。例文は could の項を参照のこと。

I believe

これはやや強く確信を持っている感じ。

I believe so.

I believe Dhruba was doing some
experimentation with an approach like this.

I'm sure

これを言うとビジネスマンが自信満々に「私の言う通りにすれば間違いありません!」みたいに言っているイメージ。
かなり強く確信を持っている。

I'm sure there's
other ways, but here's how I did it.

as follows:

箇条書きで列挙するときに使う言葉。

An approximate pre-processing solution can be as follows:
* maintain a TTL based cache of all identities.
* Do an atomic put-if-absent operation on this cache
* Increment the counter if the put succeeds.


設定ファイルやログなんかを貼り付けるときも使える。

I have configured the block size as follows on all machines (although,
I thought it was only necessary on the namenode):


dfs.block.size
134217728
true

IMO

in my opinion つまり「私見では」「私が思うに」など。

What's missing, IMO, is a uniform response that says the system is
nominal.

IIRC

「私の記憶が確かならば」
IIRC, 正式には If I remember correctly だったと思う。

IIRC they were using thrift as well.

BTW

by the way 「ところで」

btw, I'm not sure I understood your last comment, how did you do to pull bytearrays so ?

FWIW

for what it's worth 「それはそれとして」

btw は話を完全に変えるのに対し、fwiw は同一トピックの違う箇所に話の方向を変える感じ。

It was finally backported in 0.20.204 now, so you may use that instead
as it has just released. Also, FWIW, the CDH3 stable distro has
carried that fix for over a year now.

WRT

wrt, w.r.t とも。

with respect to 「…に関しては」

But those events are relatively short lived so usually not a big deal WRT block replication.

chime in

口を出す、割って入るの意味だが、「補足する」とか「リアクションしてくれる」などの意味になっていることが多い。

This is from memory, but I expect someone will chime in if any detail is inaccurate. :-)


また、そんなに多用はされないけど jump in ということもある。こちらはもう少し深く内容に足を突っ込むニュアンス。

If I could jump in here.

let me know

「教えてください」という丁寧な言い方。

Could you let me know ~? とかはよく使う。より丁寧な言い回し。

あと、質問するときに最後に if you need any more information, please let me know みたいに書いておくこともある。

would like to, 'd like to

「~したい」の丁寧な言い回し。

I'm curious

辞書引くと「好奇心を持つ」とか書いてあるが、一体どうしてこんなバグ起きたんだ、とかなんであんな風になったんだ、とかでわりと使う。
interesting などよりも、もっと奥深いとこまで興味があるイメージ。
内部構造を知りたい、とか詳細な動作を知りたい、などのときにも使ったりする。

in production

「本番環境で」

production 環境と書くだけで重みが変わってくるのは万国共通。

file a jira

JIRA に新しいチケットを作成すること。

This is surely a bug. Could you file a new JIRA for this?

It might be good to file a JIRA to add in some sort of check.

他にも何か思いついたら追記する。