Optimieren der Abfrageleistung mit Index Advisor in Azure DocumentDB (Vorschau)

Index Advisor ist ein integrierter Leistungsoptimierungs-Assistent für Azure DocumentDB, der Ihnen hilft, langsame Abfragen zu diagnostizieren, das Ausführungsverhalten von Abfragen zu verstehen und optimierte Indexstrategien zu implementieren. Index Advisor analysiert Ihre Abfragestruktur zusammen mit Sammlungs- und Indexstatistiken. Index Advisor generiert dann klare, datengesteuerte Empfehlungen mit lesbaren Erklärungen, die beschreiben, warum ein bestimmter Index zur Verbesserung der Leistung beitragen würde.

Vorteile von Index Advisor

Hier sind einige Vorteile der Verwendung von Index Advisor.

  • Identifizieren sie Leistungsengpässe und ineffiziente Abfragen.
  • Empfangen von Empfehlungen für umsetzbare Indexe , priorisiert nach Leistungseffekt.
  • Verstehen Sie, warum ein Index durch klare, einfache englische Erklärungen wichtig ist.
  • Wenden Sie Indexempfehlungen sofort innerhalb der Erweiterung an.
  • Vergleichen Sie die Leistung vor und nach der Ausführung automatisch, sobald der Index erstellt wurde.

Anwendungsfälle für Den Indexratgeber

Index Advisor unterstützt verschiedene Abfragemuster und Optimierungsszenarien, um die Datenbankleistung zu verbessern.

Scenario Description
Gleichheits-/Bereichsabfrage Behandelt einfache Gleichheits- oder Bereichsfilter (z. B. field = value oder field > value).
Zusammengesetzter Filter / gedeckte Abfrage / Lookup-Join Analysiert Abfragen, die mehrere Filterbedingungen oder Verknüpfungen umfassen, die mit zusammengesetzten oder abgedeckten Indizes für Suchabfragen optimiert werden können.
Zusammengesetzter Index Schlägt Indizes mit mehreren Feldern (zusammengesetzt) vor, um komplexe Such-/Sortierabfragen zu unterstützen
Nur sortieren Gibt an, wann ein Sortiervorgang verbessert oder von einem Index abgedeckt werden kann.
Filtern + Sortieren / Index-Pushdown Empfiehlt Indexstrukturen, die die effiziente Verarbeitung von Filtern und Sortieren innerhalb der Indexebene ermöglichen, wodurch Dokumentscans reduziert werden.
Vorhandene Indexabdeckung Unterstützt für Suchabfragen; wenn bereits ein Index vorhanden ist, wird kein neuer Index vorgeschlagen.

Wenn Ihr Abfrageszenario außerhalb dieser Muster liegt, wenden Sie sich an das Azure DocumentDB-Team , um Unterstützung bei Ihrem spezifischen Anwendungsfall zu erhalten.

Prerequisites

  • Ein Azure-Abonnement

    • Wenn Sie nicht über ein Azure-Abonnement verfügen, erstellen Sie ein kostenloses Konto

  • Ein vorhandener Azure DocumentDB-Cluster

    • Wenn Sie keinen Cluster haben, erstellen Sie einen neuen Cluster.

Herstellen einer Verbindung mit Ihrem Azure DocumentDB-Cluster

Stellen Sie eine Verbindung mit Ihrem Azure DocumentDB-Cluster in der Visual Studio Code-Erweiterung her.

  1. Öffnen Sie die Erweiterung DocumentDB für Visual Studio Code über die Aktivitätsleiste.

  2. Wählen Sie "Verbindung hinzufügen" aus, um eine neue Clusterverbindung zu erstellen.

  3. Wählen Sie Ihre Authentifizierungsmethode aus, und geben Sie die erforderlichen Verbindungsdetails an.

  4. Testen Sie die Verbindung, um sicherzustellen, dass sie ordnungsgemäß funktioniert.

  5. Erweitern Sie Ihren Cluster, um verfügbare Datenbanken und Sammlungen anzuzeigen.

Öffnen einer Abfrage für die Analyse

Beginnen Sie mit der Leistungsanalyse mit dem Indexratgeber, indem Sie eine Abfrage in der DocumentDB-Erweiterung öffnen.

  1. Öffnen Sie eine Such-, Aggregat- oder Count-Abfrage in der Erweiterung.

  2. Wechseln Sie zur Registerkarte "Abfrageeinblicke ".

  3. Führen Sie Ihre Abfrage aus. Das Panel zeigt wichtige Leistungsindikatoren wie Ausführungszeit, zurückgegebene Dokumente, untersuchte Schlüssel und geprüfte Dokumente an. Index Advisor sammelt und analysiert den Abfrageausführungsplan und Statistiken aus dem verbundenen Cluster (Standardmodus) oder aus vorinstallierten Daten (Preload Mode). Ein Sprachmodell (GitHub Copilot) untersucht den bereinigten Plan und die Statistiken, um optimale Indizes zu empfehlen.

    Important

    Alle Literalabfragewerte (z. B. E-Mails, Zahlen oder Text) werden durch <value> Platzhalter ersetzt, bevor sie zur Analyse gesendet werden.

    Hier ist ein Beispiel für die Bereinigung:

    • Eine unsanitisierte Abfrage, die nicht gesendet wird

      {
  "filter": {
    "email": "john.doe@example.com",
    "age": { "$gt": 25 }
  }
}

    • Bereinigte Abfrage, die gesendet wird

      {
  "filter": {
    "email": "<value>",
    "age": { "$gt": "<value>" }
  }
}

  4. Wenden Sie eine Empfehlung direkt an; die Erweiterung erstellt den Index und führt die Abfrage erneut aus, um Leistungsmetriken zu aktualisieren.

  5. Überprüfen Sie die Zusammenfassungen "Abfragestatistik" und "Ausführungsplan ".

    Screenshot des Abschnitts

  6. Entdecken Sie die Liste "Optimierungsmöglichkeiten" . Jede Empfehlung enthält eine für Menschen lesbare Erklärung und eine vorgeschlagene Indexdefinition.

    Screenshot der Optimierungsmöglichkeiten mit einer Liste von Empfehlungen für die aktuelle Abfrage.

  7. Wählen Sie "Übernehmen" aus, um den empfohlenen Index zu erstellen. Die Indexerstellung wird asynchron im Hintergrund ausgeführt. Nach Abschluss des Vorgangs wird der Bereich automatisch mit aktualisierten Ergebnissen aktualisiert. Nach der Indexerstellung führt der Index Advisor die Analyse erneut durch und aktualisiert die Metriken, damit Sie Leistungsverbesserungen vergleichen können.

Einschränkungen des Indexratgebers

Hier sind die Einschränkungen der Index-Advisor-Funktion.

  • Regionale Verfügbarkeit: Index Advisor ist derzeit nur in den Regionen USA und Kanada verfügbar.
  • Indexverwaltung: Der Indexratgeber empfiehlt nur das Erstellen neuer Indizes; Es wird nicht empfohlen, vorhandene Indizes zu diesem Zeitpunkt abzulegen oder auszublenden.
  • Szenarioabdeckung: In dieser Version sind nur die zuvor aufgeführten unterstützten Szenarien optimiert. Wenden Sie sich für andere Abfragetypen an das Azure DocumentDB-Team , oder schauen Sie sich die bewährten Methoden für die Indizierung an.
  • Vertraulichkeit von Daten: Behandeln Sie Datenbank- und Sammlungsnamen als Metadaten, überprüfen Sie jedoch weiterhin interne Datenklassifizierungsrichtlinien.

Bewährte Methoden bei Verwendung von Index Advisor

Hier finden Sie bewährte Methoden für die Verwendung des Indexratgeberfeatures.

  • Befolgen Sie die Datengovernancerichtlinien Ihrer Organisation beim Exportieren oder Freigeben von Statistiken.
  • Überprüfen Sie die Indexempfehlungen, bevor Sie sie anwenden, um sicherzustellen, dass sie ihren Arbeitsauslastungs- und Kostenanforderungen entsprechen.
  • Vermeiden Sie manuelles Ablegen von Indizes, ohne Abhängigkeiten zu überprüfen oder mit dem Azure DocumentDB-Team zu beraten.
  • Wenn Ihre Abfragemuster nicht unterstützt werden, sehen Sie sich die bewährten Methoden für die Indizierung an, um Anleitungen und Unterstützung zu erhalten.

Überlegungen für den Indexratgeber

Index Advisor ist so aufgebaut, dass Sie Abfragen optimieren und gleichzeitig Ihre Privatsphäre bei jedem Schritt schützen können.

Diese Liste zeigt Die von der Erweiterung gesammelten Daten:

  • Abfrageausführungspläne – Strukturelle Informationen und Leistungsmetriken.
  • Sammlungsstatistiken – Dokumentanzahl, Daten und Indexgrößen und Indexanzahl.
  • Indexdetails – Indexnamen , Schlüsselmuster und Verwendungsmetriken.
  • Clustermetadaten – eingeschränkte Informationen wie Azure-Hostingstatus und API-Typ.

Compliance und Datenschutz

Um Compliance und Datenschutz zu gewährleisten, implementiert das System vor dem Senden von Informationen zur Analyse die folgenden Schutzmaßnahmen:

  • Ersetzen aller Literalwerte in Abfragen und Ausführungsplänen durch <value>.
  • Beibehalten von Feldnamen und Abfrageoperatoren (z. B. email, $gt, $in), um den Kontext zu bewahren.
  • Vollständige Bereinigung von Ausführungsplänen, um sicherzustellen, dass keine vertraulichen oder persönlichen Daten verbleiben.
  • Die Leistungsmetriken (wie z. B. nReturned oder executionTimeMillis) beizubehalten, da sie keine Literalwerte aus Ihren Daten enthalten.
  • Übertragung nur der sanitisierten Struktur, der für die Analyse erforderlichen Statistiken und Metadaten, niemals jedoch Beispieldokumente oder Rohwerte.
  • Jede zukünftige Funktion, für die unbereinigte Daten erforderlich sind, muss vollständigen Datenschutz- und Compliance-Überprüfungen von Microsoft unterzogen werden.

Index Advisor analysiert nur Abfragestruktur und Leistungsmerkmale, niemals Ihre tatsächlichen Daten.

Verwandte Inhalte

  • Last updated on