Skip to content

πŸ“Š Analyze ClickHouse usage to uncover table relationships, discover safe cleanup options, and generate insightful visual reports effortlessly.

Notifications You must be signed in to change notification settings

samiullahhussai/clickspectre

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

10 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸŽ‰ clickspectre - Analyze Your ClickHouse Usage Easily

πŸš€ Getting Started

Welcome to clickspectre! This tool helps you understand how your ClickHouse database is used and optimizes its performance. We will walk you through downloading and running the application step-by-step.

πŸ”— Download clickspectre

πŸ“₯ Download & Install

To get started, follow these steps:

  1. Visit the Releases page.

  2. Look for the latest version of clickspectre.

  3. Download the file that matches your operating system (Windows, macOS, or Linux). You will find different versions available for each system.

  4. Once downloaded, locate the file on your computer.

    • Windows: Double-click the .exe file to start the installation.
    • macOS: Open the .dmg file, then drag the clickspectre icon into your Applications folder.
    • Linux: Use the terminal to install the package using the command provided in the release notes.
  5. Follow the on-screen instructions to complete the installation.

πŸ”§ How to Use clickspectre

Now that you have clickspectre installed, here’s how to use it:

  1. Open clickspectre: Locate the application in your installed programs.
  2. Connect to ClickHouse: Enter the connection details for your ClickHouse database. This typically includes the host, port, username, and password.
  3. Analyze Your Database:
    • Start a new analysis to see which tables are actively used.
    • Review the list of queries mapped to IP addresses or Kubernetes services.
    • Get insights into unused tables and orphaned materialized views.

πŸ“ Features

  • Usage Tracking: Understand which tables are accessed and by whom.
  • Dead Table Detection: Easily identify tables that are no longer in use.
  • Kubernetes Integration: Monitor usage within your K8s clusters.
  • Table and View Management: Keep your database clean by managing materialized views and unused tables effectively.
  • Performance Insights: Analyze query performance and pinpoint optimizations.

βš™οΈ System Requirements

clickspectre is designed to run on most modern systems. Here are the key requirements:

  • Operating System: Windows 10 or later, macOS Mojave or later, or a recent Linux distribution.
  • Memory: At least 4GB of RAM.
  • Disk Space: 100MB of available storage for installation.
  • Network: Internet connection is required for database connections.

πŸ”— Additional Resources

For more help or to explore deeper features, check the following resources:

🀝 Contributing

If you have ideas or improvements, we welcome contributions! Here’s how:

  1. Fork the repository.
  2. Make your changes in a new branch.
  3. Submit a pull request with a clear description of your changes.

πŸ› οΈ Support

For support, please open an issue on our GitHub Issues page. We are here to help you with your problems and suggestions.

πŸ”— Download clickspectre again if needed.

Thank you for choosing clickspectre. Enjoy optimizing your ClickHouse experience!

About

πŸ“Š Analyze ClickHouse usage to uncover table relationships, discover safe cleanup options, and generate insightful visual reports effortlessly.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published