influxdata/influxdb

full scan as JSON

• Minimize critical path allocationsAvoid unnecessary memory allocations in performance-critical code paths. These allocations not only consume memory but also trigger expen...

  influxdata/influxdb Performance Optimization Rust data-systems 2025-05-26

  copy raw open
• Use descriptive namesNames in code should be self-documenting, accurately reflect purpose, and follow consistent conventions. Apply these principles throughou...

  influxdata/influxdb Naming Conventions Go data-systems 2025-04-04

  copy raw open
• Promote code clarityWrite code that prioritizes clarity and maintainability over brevity. This involves several key practices: 1. **Extract repeated code blo...

  influxdata/influxdb Code Style Rust data-systems 2025-02-28

  copy raw open
• Lock with defer unlockAlways follow the lock-defer-unlock pattern when protecting shared resources with mutexes. Acquire the lock, immediately use defer to ens...

  influxdata/influxdb Concurrency Go data-systems 2025-02-12

  copy raw open
• Choose appropriate lock primitivesSelect lock types based on access patterns - prefer RWLock over Mutex for read-heavy operations to enable concurrent reads while allowing...

  influxdata/influxdb Concurrency Rust data-systems 2024-10-03

  copy raw open
• Use testify assertionsAlways use the testify package (require/assert) in tests instead of standard Go testing assertions. The testify library provides more des...

  influxdata/influxdb Testing Go data-systems 2025-01-14

  copy raw open
• Follow API conventionsDesign APIs following modern conventions and best practices to improve usability, maintainability, and consistency across your codebase. ...

  influxdata/influxdb API Rust data-systems 2025-06-03

  copy raw open
• Wrap errors with contextAlways wrap errors with meaningful context using fmt.Errorf and %w verb. Include relevant identifiers (filenames, IDs, paths) in error me...

  influxdata/influxdb Error Handling Go data-systems 2025-01-07

  copy raw open
• Choose optimal data structuresSelect data structures based on specific access patterns and performance requirements. When both fast lookup and predictable iteration or...

  influxdata/influxdb Algorithms Rust data-systems 2024-11-01

  copy raw open
• Descriptive semantic namingCreate identifiers that clearly convey meaning through descriptive names and appropriate types. Two key practices improve code readabilit...

  influxdata/influxdb Naming Conventions Rust data-systems 2025-06-03

  copy raw open
• Prefer explicit nullabilityAlways make nullable states explicit in your code by leveraging Rust's type system. Use `Option` rather than sentinel values (like emp...

  influxdata/influxdb Null Handling Rust data-systems 2025-06-03

  copy raw open
• Maintain code readabilityEnsure code remains readable and maintainable by following these practices: 1. **Combine case statements with identical outcomes** to red...

  influxdata/influxdb Code Style Go data-systems 2025-05-21

  copy raw open
• Structured logging best practicesUse structured logging with appropriate field types and context to make logs more useful for troubleshooting. Choose specific field types...

  influxdata/influxdb Logging Go data-systems 2025-04-18

  copy raw open
• Clear configuration parametersConfiguration parameters should be descriptively named, well documented, and have sensible defaults that are visible to users. This makes...

  influxdata/influxdb Configurations Rust data-systems 2025-04-16

  copy raw open
• Manage complete cache lifecycleImplement comprehensive cache lifecycle management focusing on three key aspects: 1. Idempotent Creation: Make cache creation idempotent ...

  influxdata/influxdb Caching Rust data-systems 2025-03-14

  copy raw open
• Handle errors by criticalityChoose error handling strategies based on operation criticality:\n\n\ 1. For critical operations that could corrupt data or state:\n - ...

  influxdata/influxdb Error Handling Rust data-systems 2025-01-17

  copy raw open
• Stable schema identifiersUse persistent identifiers for schema elements rather than relying on positional information or enumeration, which can break when schema ...

  influxdata/influxdb Database Rust data-systems 2024-10-10

  copy raw open
• Use structured logging fieldsAlways use structured logging with descriptive field names rather than string interpolation. Include relevant context variables such as i...

  influxdata/influxdb Logging Rust data-systems 2025-06-03

  copy raw open
• Performance-conscious metrics implementationImplement metrics collection that is both comprehensive and minimally impactful on system performance. Design your metrics system to avoi...

  influxdata/influxdb Observability Rust data-systems 2025-06-02

  copy raw open
• Avoid unnecessary workWhen optimizing performance-critical code paths, eliminate redundant operations and unnecessary processing: 1. **Exit loops early** when ...

  influxdata/influxdb Performance Optimization Go data-systems 2025-04-07

  copy raw open
• Prefer configurable valuesAlways use configurable values instead of hardcoded defaults when available. This ensures that user preferences are respected throughout ...

  influxdata/influxdb Configurations Go data-systems 2025-04-07

  copy raw open
• Prevent nil dereferencesAlways verify that pointers, slices, or arrays are non-nil and have sufficient elements before attempting to access their members. Use ap...

  influxdata/influxdb Null Handling Go data-systems 2025-02-26

  copy raw open
• Avoid flaky test patternsWrite reliable tests by avoiding common patterns that can lead to flaky behavior. Specifically: 1. Avoid arbitrary timeouts and sleeps in...

  influxdata/influxdb Testing Rust data-systems 2025-01-17

  copy raw open
• Include explanatory examplesAlways enhance documentation with concrete, illustrative examples that demonstrate expected inputs, formats, or outputs. Examples signifi...

  influxdata/influxdb Documentation Rust data-systems 2025-01-03

  copy raw open
• Secure token lifecycleImplement comprehensive lifecycle controls for authentication tokens to maintain security throughout token creation, usage, and deletion ...

  influxdata/influxdb Security Rust data-systems 2025-05-14

  copy raw open
• Explicit security parametersSecurity-critical features should be implemented as required parameters rather than optional parameters or option functions. This forces ...

  influxdata/influxdb Security Go data-systems 2025-02-21

  copy raw open
• Document complete data flowsWhen documenting database systems, ensure all documentation includes complete end-to-end data flows. Both diagrams and textual descriptio...

  influxdata/influxdb Database Markdown data-systems 2025-01-24

  copy raw open
• Type over primitivesUse domain-specific types instead of primitives (like strings, []byte, or generic maps) to represent domain concepts in algorithms. This ...

  influxdata/influxdb Algorithms Go data-systems 2024-09-13

  copy raw open
• Complete schema managementWhen working with database systems that have flexible schemas (like InfluxDB), ensure complete schema discovery and proper merging from a...

  influxdata/influxdb Database Go data-systems 2024-09-05

  copy raw open
• Centralize workspace configurationsCentralize configuration settings like dependency versions and feature flags at the workspace level rather than duplicating them across i...

  influxdata/influxdb Configurations Toml data-systems 2025-05-19

  copy raw open
• Document versioning strategiesEstablish and clearly document versioning strategies in configuration files, both for your application and its dependencies. For applicat...

  influxdata/influxdb Configurations Yaml data-systems 2025-03-19

  copy raw open
• Document function signaturesAlways document function parameters and return values in the function header comment or interface definition. This is particularly import...

  influxdata/influxdb Documentation Go data-systems 2024-12-16

  copy raw open
• Vet security-critical dependenciesWhen introducing new dependencies, especially those handling sensitive operations like language interpreters, perform comprehensive secur...

  influxdata/influxdb Security Toml data-systems 2025-01-31

  copy raw open