Skip to content

docs: 日本語での README の内容を追加し、インストール方法や使用例を明確化 - #13

Merged
kazeburo merged 1 commit into
masterfrom
feat/improve-readme
Sep 4, 2026
Merged

kazeburo merged 1 commit into
masterfrom
feat/improve-readme

Conversation

@kazeburo

@kazeburo kazeburo commented Sep 4, 2026 •

Copy link
Copy Markdown
Member

PR Type

Documentation


Description

  • Localize README content into Japanese

  • Add installation and usage guidance

  • Document agent configuration and metrics

  • Clarify latency metric calculation behavior


Diagram Walkthrough

flowchart LR
  install["Installation"] 
  usage["Command usage"]
  agent["mackerel-agent configuration"]
  metrics["Published metrics"]
  install -- "enables" --> usage
  usage -- "configured in" --> agent
  agent -- "reports" --> metrics
Loading

File Walkthrough

Relevant files
Documentation
README.md
Document Japanese setup, usage, and metric semantics         

README.md

  • Translate the plugin overview and operational behavior into Japanese.
  • Add mkr installation instructions and a command usage example.
  • Document mackerel-agent plugin configuration and restart steps.
  • Define emitted metrics, units, and failed-request behavior.
+61/-18 

@sonarqubecloud

sonarqubecloud Bot commented Sep 4, 2026

Copy link
Copy Markdown

@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Invalid agent config

mackerel-agent.conf expects a string command value, not a command argument array. Using this example can prevent the agent from loading the plugin configuration; provide the complete command as a quoted string instead.

command = ["/usr/local/bin/mackerel-plugin-httping", "--url", "https://example.com/", "--key-prefix", "example", "--count", "10", "--interval", "200"]

@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

PR Code Suggestions ✨

No code suggestions found for the PR.

@kazeburo
kazeburo merged commit 607d10b into master Sep 4, 2026
3 checks passed
@kazeburo
kazeburo deleted the feat/improve-readme branch September 4, 2026 14:21
@github-actions github-actions Bot mentioned this pull request Sep 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant