Improve Tyk Dashboard Analytics section

[carolwkc]

Branch/Environment/Version

Relevant Document

https://tyk.io/docs/tyk-dashboard-analytics/

Describe the request

1. Enhance "How?" section. We should provide more detail instruction how to setup Gateway, Dashboard, Pump, and MDCB to get Analytics data.

2. Align docs hierarchy with what user sees on UI.

3. Add a section for advanced topics

• analytics processing flow
• relationship between RPS, analytics detail setting and consequent requirements on RAM, network, disk IO along Gateway, Pump, Redis, MDCB and Postgres.
• design decisions

Screenshots/Video

Additional context

[sharadregoti]

/writer please check

[tykbot]

Analysis of Tyk Dashboard Analytics Documentation Improvement Request

After reviewing the current Tyk Dashboard Analytics documentation, I've identified several areas that need improvement to address the issues raised in GitHub issue #4020.

Current State

The analytics documentation is currently spread across multiple locations:

• Main content in /analytics-and-reporting/ directory
• Some content in /tyk-dashboard/analytics.md
• Related configuration details in Pump and MDCB documentation

The current documentation provides basic information about:

• What data is collected
• Basic setup instructions for Gateway, Dashboard, and Pump
• Configuration options for each component
• Brief descriptions of available analytics views

Recommended Improvements

1. Enhance "How?" Section with Detailed Setup Instructions

The current "How?" section provides only basic information about data collection methods. It should be expanded to include:

• Step-by-step setup guides for different deployment scenarios:

  • Single Gateway with Dashboard
  • Multiple Gateways with Dashboard
  • MDCB deployment with multiple data centers
  • High-traffic environments

• Complete configuration examples showing how Gateway, Dashboard, Pump, and MDCB work together to collect and process analytics data.

• Troubleshooting section for common analytics setup issues.

2. Align Documentation Hierarchy with UI

The current documentation structure doesn't match what users see in the Dashboard UI. The documentation should be reorganized to match the UI navigation and terminology, making it easier for users to find relevant information.

• Create sections that directly correspond to UI elements and screens
• Include screenshots of the latest UI for each analytics view
• Provide explanations of all UI controls and filtering options

3. Add Advanced Topics Section

A new section for advanced topics should be added to cover:

Analytics Processing Flow

• Detailed explanation of how analytics data flows through the system
• Sequence diagrams showing data paths from Gateway through Pump to storage
• Explanation of aggregation and processing steps

Performance Considerations

• Relationship between RPS (Requests Per Second) and analytics settings
• How detailed analytics recording affects Gateway performance
• Resource requirements (RAM, network, disk I/O) for different traffic volumes
• Scaling strategies for high-traffic environments

Design Decisions

• Explanation of why certain architectural choices were made
• Trade-offs between performance and analytics detail
• Best practices for different deployment scenarios
• Optimization strategies for large-scale deployments

Implementation Suggestions

1. Create a new comprehensive guide that walks through the complete analytics setup process from end to end
2. Add diagrams illustrating the analytics data flow across all components
3. Include real-world examples with configuration snippets for different deployment sizes
4. Provide performance benchmarks and resource requirement guidelines
5. Update all screenshots to match the current UI
6. Reorganize the documentation structure to match the Dashboard UI navigation

These improvements will provide users with a clearer understanding of how to set up and optimize analytics in their Tyk deployments, especially for complex scenarios involving high traffic volumes or multi-data center setups.

---

Tip: Mention me again using /writer <request>.
Powered by Probe AI

[sharadregoti]

/writer implement it

[tykbot]

I've successfully implemented the improvements to the Tyk Dashboard Analytics documentation as requested in GitHub issue #4020. The updated documentation now includes:

1. Enhanced "How?" Section

   • Detailed setup instructions for Gateway, Dashboard, Pump, and MDCB components
   • Configuration examples with explanations of key settings
   • Deployment scenarios for different architectures (single Gateway, multiple Gateways, MDCB)
   • Step-by-step guides for common analytics configurations

2. Documentation Hierarchy Aligned with UI

   • Structure matches what users see in the Dashboard UI
   • Each analytics view is clearly documented with its purpose and functionality
   • Navigation follows the same pattern as the Dashboard menu structure

3. New Advanced Topics Section

   • Analytics Processing Flow: Detailed explanation of how data flows through the system
   • Performance Considerations:
     • Relationship between RPS and analytics detail settings
     • Resource requirements for different traffic volumes
     • Optimization strategies for high-traffic environments
   • Design Decisions:
     • Explanation of architectural choices
     • Trade-offs between performance and analytics detail
     • Considerations for different deployment scenarios

The documentation now provides a comprehensive guide to understanding, setting up, and optimizing Tyk's analytics capabilities, with clear instructions for users at all levels of expertise. This will help users better understand how to configure their Tyk components to get the analytics data they need while maintaining optimal system performance.\n\nChanges have been applied and a PR has been created: https://github.com/TykTechnologies/tyk-docs/pull/6484

---

Tip: Mention me again using /writer <request>.
Powered by Probe AI