Używaj Zdalnej konfiguracji w środowiskach serwera


Firebase Remote Config obsługuje konfigurację po stronie serwera za pomocą pakietu Firebase Admin Node.js SDK w wersji 12.1.0 lub nowszej. Ta funkcja umożliwia dynamiczne zarządzanie działaniem i konfiguracją aplikacji po stronie serwera za pomocą Remote Config. Obejmuje to implementacje bezserwerowe, takie jak Cloud Functions.

W przeciwieństwie do pakietów SDK klienta Firebase, które pobierają konfigurację klienta pochodzącą z Remote Config szablonu, pakiet SDK po stronie serweraRemote Config pobiera z Firebase pełny Remote Config szablon. Serwer może następnie oceniać szablon w przypadku każdego przychodzącego żądania i używać własnej logiki do wyświetlania spersonalizowanej odpowiedzi z bardzo małym opóźnieniem. Możesz używać warunków, aby kontrolować i dostosowywać odpowiedzi na podstawie losowych wartości procentowych i atrybutów klienta zdefiniowanych w sygnałach niestandardowych.

Dzięki tagowaniu po stronie serwera Remote Config możesz:

  • Określ parametry konfiguracji aplikacji działających na serwerze lub dostępnych za jego pośrednictwem, co umożliwia korzystanie z przypadków użycia, takich jak zdalne konfigurowanie parametrów i promptów modelu AI oraz innych integracji, aby zapewnić bezpieczeństwo kluczy interfejsu API.
  • Dynamiczne dostosowywanie parametrów w odpowiedzi na zmiany w środowisku lub inne zmiany w aplikacji, np. aktualizowanie parametrów LLM i punktów końcowych modelu.
  • Kontroluj koszty, zdalnie aktualizując interfejsy API wywoływane przez serwer.
  • Generuj na bieżąco konfiguracje niestandardowe dla klientów, którzy uzyskują dostęp do Twojego serwera.
  • Rejestrowanie klientów, którzy otrzymali wartość parametru, i wykorzystywanie tych informacji w Cloud Functions w ramach systemu weryfikacji uprawnień.

Tagowanie po stronie serwera możesz wdrażać Remote Config w Cloud RunCloud Functions lub w środowiskach serwerowych hostowanych samodzielnie.

Zanim zaczniesz

Aby utworzyć projekt Firebase, skonfigurować konto usługi i dodać pakiet Firebase Admin Node.js SDK do serwera, postępuj zgodnie z instrukcjami w artykule Dodawanie pakietu Firebase Admin SDK do serwera.

Krok 1. Zainicjuj pakiet Firebase Admin Node.js SDK i autoryzuj żądania interfejsu API

Gdy zainicjujesz pakiet Admin SDK bez parametrów, użyje on domyślnych danych logowania aplikacji Google i odczyta opcje ze zmiennej środowiskowej GOOGLE_APPLICATION_CREDENTIALS. Aby zainicjować pakiet SDK i dodać Remote Config:

import { initializeApp } from "firebase-admin/app";
import { getRemoteConfig } from "firebase-admin/remote-config";

// Initialize Firebase
const firebaseApp = initializeApp();

Krok 2. Określ domyślne wartości parametrów aplikacji serwera

Wskaż w aplikacji zmienne, które chcesz dynamicznie aktualizować za pomocą Remote Config. Następnie zastanów się, które zmienne muszą być domyślnie ustawione w Twojej aplikacji i jakie powinny być ich wartości domyślne. Dzięki temu aplikacja będzie działać prawidłowo nawet wtedy, gdy połączenie z Remote Configserwerem backendu zostanie przerwane.

Jeśli na przykład piszesz aplikację serwera, która zarządza funkcją generatywnej AI, możesz ustawić domyślną nazwę modelu, wstęp do promptu i konfigurację generatywnej AI, np. taką:

Nazwa parametru Opis Typ Wartość domyślna
model_name Nazwa interfejsu API modelu Ciąg znaków gemini-2.0-flash
preamble_prompt Prompt do dodania na początku zapytania użytkownika Ciąg znaków I'm a developer who wants to learn about Firebase and you are a helpful assistant who knows everything there is to know about Firebase!
generation_config Parametry do wysłania do modelu JSON {"stopSequences": ["I hope this helps"], "temperature": 0.7, "maxOutputTokens": 512, "topP": 0.1, "topK": 20}

Krok 3. Skonfiguruj aplikację serwera

Po określeniu parametrów, których chcesz używać z Remote Config, skonfiguruj aplikację tak, aby ustawiała wartości domyślne, pobierała szablon Remote Config specyficzny dla serwera i używała jego wartości. Poniżej znajdziesz instrukcje konfigurowania aplikacji Node.js.

  1. Otwórz i wczytaj szablon.

    // Initialize server-side Remote Config
const rc = getRemoteConfig(firebaseApp);
const template = rc.initServerTemplate();

// Load Remote Config
await template.load();

    Jeśli używasz Node.js w Cloud Functions, możesz użyć asynchronicznego getServerTemplate, aby zainicjować i wczytać szablon w jednym kroku:

    // Initialize server-side Remote Config
const rc = getRemoteConfig(firebaseApp);
const template = await rc.getServerTemplate();

  2. Aby mieć pewność, że aplikacja będzie działać prawidłowo nawet wtedy, gdy połączenie z serwerem backendu Remote Config zostanie przerwane, dodaj do niej wartości domyślne każdego parametru. Aby to zrobić, dodaj znak defaultConfig w funkcji szablonu initServerTemplate lub getServerTemplate:

    const template = rc.initServerTemplate({
  defaultConfig: {
    model_name: "gemini-pro",
    generation_config: '{"stopSequences": [], "temperature": 0.7, "maxOutputTokens": 512, "topP": 0.1, "topK": 20}',
    preamble_prompt: "I'm a developer who wants to learn about Firebase and you are a helpful assistant who knows everything there is to know about Firebase!"
  },
});

// Load Remote Config
await template.load()

  3. Po wczytaniu szablonu użyj template.evaluate(), aby zaimportować parametry i wartości z szablonu:

    // Add template parameters to config
const config = template.evaluate();

  4. Opcjonalnie, jeśli w szablonie Remote Config ustawisz warunki, zdefiniuj i podaj wartości, które chcesz:

    • Jeśli używasz warunków procentowych, dodaj randomizationId, którego chcesz użyć do oceny warunków w funkcji template.evaluate().
    • Jeśli używasz sygnałów niestandardowych, zdefiniuj atrybuty i ich wartości. Sygnały niestandardowe są dostępne w pakiecie Firebase Admin Node.js SDK w wersji 12.5.0 i nowszej.

    Możesz na przykład ustawić identyfikator instalacji Firebase jako randomizationId lub identyfikator użytkownika, aby mieć pewność, że każdy użytkownik, który kontaktuje się z Twoim serwerem, jest dodawany do odpowiedniej grupy losowej. Możesz też ustawić version jako sygnał niestandardowy, aby kierować reklamy na określone wersje klienta, a platform jako sygnał niestandardowy, aby kierować reklamy na platformę klienta.

    Więcej informacji o warunkach znajdziesz w artykule Rodzaje reguł warunków.

    // Add template parameters to `config`. Evaluates the
// template and returns the parameter value assigned to
// the group assigned to the {randomizationId} and version.
const config = template.evaluate({
  randomizationId: "2ac93c28-c459-4760-963d-a3974ec26c04",
  version: "1.0",
  platform: "Android"
});

  5. Następnie wyodrębnij z konstanty konfiguracji potrzebne wartości parametrów. Użyj funkcji getters, aby przekształcić wartości z Remote Config do oczekiwanego formatu. Obsługiwane są te typy:

    • Wartość logiczna: getBoolean
    • Obiekt: getValue
    • Numer: getNumber
    • Ciąg znaków: getString

    Jeśli na przykład wdrażasz Vertex AI na serwerze i chcesz zmienić model oraz jego parametry, możesz skonfigurować parametry dla model_name i generation_config. Oto przykład, jak uzyskać dostęp do wartości Remote Config:

    // Replace defaults with values from Remote Config.
const generationConfig =
  JSON.parse(
    config.getString('generation_config'));

const is_ai_enabled = config.getBool('is_ai_enabled');

const model = config.getString('model_name');

// Generates a prompt comprised of the Remote Config
// parameter and prepends it to the user prompt
const prompt = `${config.getString('preamble_prompt')} ${req.query.prompt}`;

  6. Jeśli Twój serwer działa długo, w przeciwieństwie do środowiska bezserwerowego, używaj polecenia setInterval, aby okresowo ponownie wczytywać szablon i sprawdzać, czy pobierasz najnowszy szablon z serwera Remote Config.

Krok 4. Ustaw wartości parametrów specyficznych dla serwera w Remote Config

Następnie utwórz szablon serwera Remote Config i skonfiguruj parametry oraz wartości, których chcesz używać w aplikacji.

Aby utworzyć szablon Remote Config dotyczący konkretnego serwera:

  1. Otwórz stronę parametrów konsoli Firebase Remote Config i w selektorze Klient/serwer wybierz Serwer.
  2. Zdefiniuj Remote Config parametry o takich samych nazwach i typach danych jak parametry zdefiniowane w aplikacji i podaj wartości. Te wartości zastąpią wartości defaultConfig ustawione w sekcji Konfigurowanie aplikacji serwera podczas pobierania i oceniania szablonu oraz przypisywania tych wartości do zmiennych.
  3. Opcjonalnie możesz ustawić warunki, aby trwale stosować wartości do losowej próbki instancji lub zdefiniowanych przez Ciebie sygnałów niestandardowych. Więcej informacji o warunkach znajdziesz w artykule Rodzaje reguł warunków.
  4. Gdy skończysz dodawać parametry, kliknij Opublikuj zmiany.
  5. Sprawdź zmiany i ponownie kliknij Opublikuj zmiany.

Krok 5. Wdróż za pomocą Cloud Functions lub Cloud Run

Jeśli aplikacja serwera jest lekka i oparta na zdarzeniach, rozważ wdrożenie kodu za pomocą Cloud Functions. Załóżmy na przykład, że masz aplikację, która zawiera dialogi postaci generowane przez interfejs API generatywnej AI (np. Google AI lub Vertex AI). W takim przypadku możesz umieścić logikę obsługi LLM w funkcji, którą aplikacja wywołuje na żądanie.

Jeśli Twoja aplikacja ma działać przez długi czas (np. aplikacja internetowa z zasobami), możesz rozważyć użycie Cloud Run. Aby wdrożyć aplikację serwera za pomocą Cloud Run, postępuj zgodnie z instrukcjami w przewodniku Krótkie wprowadzenie: wdrażanie usługi Node.js w Cloud Run.

Więcej informacji o najlepszych przypadkach użycia Cloud Run i Cloud Functions znajdziesz w artykule Cloud Functions a Cloud Run: kiedy używać jednej z tych usług.

Cloud Functions