プラグイン開発記 - Redmine インフォメーションのレポート作成機能の案

以前、 思いついた Redmine インフォメーションプラグイン で環境情報ファイルを出力する機能の草案。

バグ報告のときにつけるためのファイル。 開発者は原因を特定するためにもう少し情報が欲しいなと思うことがある。 逆に報告する人はどのくらい情報をかけばいいか分からなかったり、 情報書くのがちょっと大変だったりする。
それで Redmine の動作環境情報をファイルに出力する機能があったら便利かなと思った。
ただ、必要な情報というのは場合によって変わってくるので、どんだけ役に立つかはちょっと疑問。 でも、あっても邪魔にはならないと思うので、機能は付けることにする。
あと、気をつけないといけないのが、なるべく使ってもらえるように簡単にしたいので、 自動的に情報あつめてたいけど、そのときセキュリティーにかかわるような情報を入れないようにすること。

いるかなとか、出せるなと思った情報は次のようなもの。
Redmine のバージョン
やっぱり、これは要るでしょう。すでに表示はしているので、同じようにとってくる
Ruby, Rails のバージョン、DB の種類
これは Rails 情報をとってくるメソッド(Rails::Info.to_html)が Rails にある。 表示は html で出力するものだけど、テキスト用(to_s)もあるのでそっちを使う。
動作モード
環境変数 RAILS_ENV からとってこれる。 環境変数の値を全部出力することもできるけど、そんなにはいらないかなと思うので、 動作モードだけにしておく
Redmine プラグインのバージョン
対象のプラグインを選択してもらうのも面倒だし、 他のプラグインで影響がでてくることも考えられるので、 インストールされている Redmine のプラグインの全部のバージョンを出す。
Rails プラグインのバージョン
できるならあった方がいいかなとは思うけど、取得の方法がわからない。
設定情報
Redmine や プラグインの設定情報は全部を出そうと思えば出せるけど、 セキュリティ的にどうかなと思うところもあるので、とりあえず出さないでおく。
ログ
Internal Error がおきたときはぜひ欲しい。 逆に起きてない場合はそんなにいらないので、出すかどうかを選択できるようにする
ログを公開するのはセキュリティー的にどうかなと思うけど、 やっぱり欲しいので、これは自動で全部出さずにユーザーにチェックしてもらうことにする。
一旦、テキストエリアに出して、ユーザーにいらないところを削ってもらって、 残ったのを出力するといった感じ。
ログの取得方法は Logs のプラグインを参考につくる

フォームのボタンを押してファイルをダウンロードする処理は XLS export plugin でやってたので、それを参考にする。

その他の機能としては、ログとかを出すとファイルサイズが大きくなるので、 gzip で圧縮する機能。
最近のブラウザは普通に gz の展開機能がついているので、思いついたのだが、 gz で圧縮されたファイルを通常ファイルのようにみるにはサーバー側の設定がいるらしく、 普通はダウンロードが始まってしまう。
zip 圧縮も考えたが、こちらは gzip と違い標準出力への出力はできるが標準入力からの入力は出来ない。 標準入力でいれて、標準出力に出さないと一時ファイルをつくる必要があるので、 面倒になる。
外部プログラムを呼び出す処理は Graphviz で作っているので、追加するのはそんなに難しくはないと思うが、ちょっと保留にしておく。

関連記事
スポンサーサイト
Prev.    Category    Next 

Facebook コメント


コメント

コメントの投稿

Font & Icon
非公開コメント

このページをシェア
アクセスカウンター
アクセスランキング
[ジャンルランキング]
コンピュータ
43位
アクセスランキングを見る>>

[サブジャンルランキング]
プログラミング
3位
アクセスランキングを見る>>
カレンダー(アーカイブ)
プルダウン 降順 昇順 年別

05月 | 2017年06月 | 07月
- - - - 1 2 3
4 5 6 7 8 9 10
11 12 13 14 15 16 17
18 19 20 21 22 23 24
25 26 27 28 29 30 -


はてな新着記事
はてな人気記事
ブロとも申請フォーム
プロフィール

yohshiy

Author:yohshiy
職業プログラマー。
仕事は主に C++ ですが、軽い言語マニアなので、色々使っています。

はてブ:yohshiy のブックマーク
Twitter:@yohshiy

サイト紹介
プログラミング好きのブログです。プログラミング関連の話題や公開ソフトの開発記などを雑多に書いてます。ただ、たまに英語やネット系の話になることも。