Java'da üretken yapay zeka uygulamaları için pratik gözlemlenebilirlik teknikleri

1. Genel Bakış

Üretken yapay zeka uygulamaları, diğer uygulamalar gibi gözlemlenebilirlik gerektirir. Üretken yapay zeka için özel gözlemlenebilirlik teknikleri gerekiyor mu?

Bu laboratuvarda basit bir üretken yapay zeka uygulaması oluşturacaksınız. Cloud Run'a dağıtın. Ayrıca Google Cloud gözlemlenebilirlik hizmetlerini ve ürünlerini kullanarak temel izleme ve günlük kaydı özellikleriyle donatın.

Öğrenecekleriniz

  • Cloud Shell Düzenleyici ile Vertex AI'ı kullanan bir uygulama yazma
  • Uygulama kodunuzu GitHub'da saklama
  • Uygulamanızın kaynak kodunu Cloud Run'a dağıtmak için gcloud CLI'yı kullanın.
  • Üretken yapay zeka uygulamanıza izleme ve günlük kaydı özellikleri ekleme
  • Günlük tabanlı metrikleri kullanma
  • Open Telemetry SDK ile günlük kaydını ve izlemeyi uygulama
  • Sorumlu yapay zeka veri işleme hakkında bilgi edinme

2. Ön koşullar

Google Hesabınız yoksa yeni bir hesap oluşturmanız gerekir.

3. Proje ayarlama

  1. Google Hesabınızla Google Cloud Console'da oturum açın.
  2. Yeni bir proje oluşturun veya mevcut bir projeyi yeniden kullanmayı seçin. Yeni oluşturduğunuz veya seçtiğiniz projenin proje kimliğini not edin.
  3. Proje için faturalandırmayı etkinleştirin.
    • Bu laboratuvarı tamamlamanın faturalandırma maliyeti 5 ABD dolarından az olmalıdır.
    • Daha fazla ücret ödememek için bu laboratuvarın sonundaki adımları uygulayarak kaynakları silebilirsiniz.
    • Yeni kullanıcılar 300 ABD doları değerinde ücretsiz deneme sürümünden yararlanabilir.
  4. Cloud Billing'deki Projelerim bölümünde faturalandırmanın etkinleştirildiğini onaylayın
      .
    • Yeni projenizin Billing account sütununda Billing is disabled yazıyorsa:
      1. Actions sütunundaki üç noktayı tıklayın.
      2. Faturalandırmayı değiştir'i tıklayın.
      3. Kullanmak istediğiniz faturalandırma hesabını seçin.
    • Canlı bir etkinliğe katılıyorsanız hesabın adı büyük olasılıkla Google Cloud Platform Deneme Sürümü Faturalandırma Hesabı olur.

4. Cloud Shell Düzenleyici'yi hazırlama

  1. Cloud Shell Düzenleyici'ye gidin. Kimlik bilgilerinizle gcloud'u çağırması için Cloud Shell'i yetkilendirmenizi isteyen aşağıdaki mesajı görürseniz devam etmek için Yetkilendir'i tıklayın.
    Cloud Shell'e yetki vermek için tıklayın.
  2. Terminal penceresini açın.
    1. Hamburger menüsünü Hamburger menü simgesi tıklayın.
    2. Terminal'i tıklayın.
    3. Yeni Terminal
      'i tıklayın.Cloud Shell Düzenleyici'de yeni terminal açma
  3. Terminalde proje kimliğinizi yapılandırın:
    gcloud config set project [PROJECT_ID]
    [PROJECT_ID] yerine projenizin kimliğini yazın. Örneğin, proje kimliğiniz lab-example-project ise komut şu şekilde olur:
    gcloud config set project lab-project-id-example
    gcloud'un GCPI API için kimlik bilgilerinizi istediğini belirten aşağıdaki mesajı görürseniz devam etmek için Yetkilendir'i tıklayın.
    Cloud Shell'e yetki vermek için tıklayın.
    Başarılı bir şekilde yürütüldüğünde aşağıdaki mesajı görmeniz gerekir:
    Updated property [core/project].
    WARNING simgesini görüyorsanız ve Do you want to continue (Y/N)? soruluyorsa proje kimliğini yanlış girmiş olabilirsiniz. N tuşuna, Enter tuşuna basın ve doğru proje kimliğini bulduktan sonra gcloud config set project komutunu tekrar çalıştırmayı deneyin.
  4. (İsteğe bağlı) Proje kimliğini bulmakta sorun yaşıyorsanız tüm projelerinizin oluşturulma zamanına göre azalan sırada sıralanmış proje kimliklerini görmek için aşağıdaki komutu çalıştırın:
    gcloud projects list \
     --format='value(projectId,createTime)' \
     --sort-by=~createTime

5. Google API'lerini etkinleştirme

Terminalde, bu laboratuvar için gerekli olan Google API'lerini etkinleştirin:

gcloud services enable \
     run.googleapis.com \
     cloudbuild.googleapis.com \
     aiplatform.googleapis.com \
     logging.googleapis.com \
     monitoring.googleapis.com \
     cloudtrace.googleapis.com

Bu komutun tamamlanması biraz zaman alabilir. Sonunda, şuna benzer bir başarı mesajı oluşturur:

Operation "operations/acf.p2-73d90d00-47ee-447a-b600" finished successfully.

ERROR: (gcloud.services.enable) HttpError accessing ile başlayan ve aşağıdakine benzer hata ayrıntıları içeren bir hata mesajı alırsanız 1-2 dakika bekledikten sonra komutu yeniden deneyin.

"error": {
  "code": 429,
  "message": "Quota exceeded for quota metric 'Mutate requests' and limit 'Mutate requests per minute' of service 'serviceusage.googleapis.com' ...",
  "status": "RESOURCE_EXHAUSTED",
  ...
}

6. Üretken yapay zeka uygulaması oluşturma

Bu adımda, seçtiğiniz bir hayvanla ilgili 10 eğlenceli bilgiyi göstermek için Gemini modelini kullanan basit bir isteğe dayalı uygulama kodu yazacaksınız. Uygulama kodu oluşturmak için aşağıdakileri yapın.

  1. Terminalde codelab-o11y dizinini oluşturun:
    mkdir "${HOME}/codelab-o11y"
  2. Mevcut dizini codelab-o11y olarak değiştirin:
    cd "${HOME}/codelab-o11y"
  3. Spring Framework Starter'ı kullanarak Java uygulamasının bootstrap kodunu indirin:
    curl https://start.spring.io/starter.zip \
    -d dependencies=web \
    -d javaVersion=17 \
    -d type=maven-project \
    -d bootVersion=3.4.1 -o java-starter.zip
  4. Bootstrap kodunu geçerli klasöre çıkarın:
    unzip java-starter.zip
  5. Arşiv dosyasını klasörden kaldırın:
    rm java-starter.zip
  6. Kodu Cloud Run'a dağıtırken kullanılacak Java çalışma zamanı sürümünü tanımlamak için project.toml dosyası oluşturun:
    cat > "${HOME}/codelab-o11y/project.toml" << EOF
[[build.env]]
    name = "GOOGLE_RUNTIME_VERSION"
    value = "17"
EOF
  7. pom.xml dosyasına Google Cloud SDK bağımlılıklarını ekleyin:
    1. Google Cloud Core paketini ekleyin:
      sed -i 's/<dependencies>/<dependencies>\
\
        <dependency>\
            <groupId>com.google.cloud<\/groupId>\
            <artifactId>google-cloud-core<\/artifactId>\
            <version>2.49.1<\/version>\
        <\/dependency>\
        /g' "${HOME}/codelab-o11y/pom.xml"
    2. Google Cloud Vertex AI paketini ekleyin:
      sed -i 's/<dependencies>/<dependencies>\
\
        <dependency>\
            <groupId>com.google.cloud<\/groupId>\
            <artifactId>google-cloud-vertexai<\/artifactId>\
            <version>1.16.0<\/version>\
        <\/dependency>\
        /g' "${HOME}/codelab-o11y/pom.xml"
  8. DemoApplication.java dosyasını Cloud Shell Düzenleyici'de açın:
    cloudshell edit "${HOME}/codelab-o11y/src/main/java/com/example/demo/DemoApplication.java"
    DemoApplication.java dosyasının iskeletli kaynak kodu artık terminalin üzerindeki düzenleyici penceresinde görünmelidir. Dosyanın kaynak kodu aşağıdaki gibi olacaktır:
    package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}
  9. Düzenleyicideki kodu aşağıda gösterilen sürümle değiştirin. Kodu değiştirmek için dosyanın içeriğini silin ve aşağıdaki kodu düzenleyiciye kopyalayın:
    package com.example.demo;

import java.io.IOException;
import java.util.Collections;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import com.google.cloud.ServiceOptions;
import com.google.cloud.vertexai.VertexAI;
import com.google.cloud.vertexai.api.GenerateContentResponse;
import com.google.cloud.vertexai.generativeai.GenerativeModel;
import com.google.cloud.vertexai.generativeai.ResponseHandler;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        String port = System.getenv().getOrDefault("PORT", "8080");
        SpringApplication app = new SpringApplication(DemoApplication.class);
        app.setDefaultProperties(Collections.singletonMap("server.port", port));
        app.run(args);
    }
}

@RestController
class HelloController {
    private final String projectId = ServiceOptions.getDefaultProjectId();
    private VertexAI vertexAI;
    private GenerativeModel model;

    @PostConstruct
    public void init() {
        vertexAI = new VertexAI(projectId, "us-central1");
        model = new GenerativeModel("gemini-1.5-flash", vertexAI);
    }

    @PreDestroy
    public void destroy() {
        vertexAI.close();
    }

    @GetMapping("/")
    public String getFacts(@RequestParam(defaultValue = "dog") String animal) throws IOException {
        String prompt = "Give me 10 fun facts about " + animal + ". Return this as html without backticks.";
        GenerateContentResponse response = model.generateContent(prompt);
        return ResponseHandler.getText(response);
    }
}
    Cloud Shell Editor, birkaç saniye sonra kodunuzu otomatik olarak kaydeder.

Üretken yapay zeka uygulamasının kodunu Cloud Run'a dağıtma

  1. Terminal penceresinde, uygulamanın kaynak kodunu Cloud Run'a dağıtma komutunu çalıştırın.
    gcloud run deploy codelab-o11y-service \
     --source="${HOME}/codelab-o11y/" \
     --region=us-central1 \
     --allow-unauthenticated
    Aşağıdaki gibi bir istem görürseniz komutun yeni bir depo oluşturacağını bildirir. Enter simgesini tıklayın.
    Deploying from source requires an Artifact Registry Docker repository to store built containers.
A repository named [cloud-run-source-deploy] in region [us-central1] will be created.

Do you want to continue (Y/n)?
    Dağıtım işlemi birkaç dakika sürebilir. Dağıtım işlemi tamamlandıktan sonra aşağıdaki gibi bir çıkış görürsünüz:
    Service [codelab-o11y-service] revision [codelab-o11y-service-00001-t2q] has been deployed and is serving 100 percent of traffic.
Service URL: https://codelab-o11y-service-12345678901.us-central1.run.app
  2. Görüntülenen Cloud Run hizmeti URL'sini tarayıcınızdaki ayrı bir sekmeye veya pencereye kopyalayın. Alternatif olarak, hizmet URL'sini yazdırmak için terminalde aşağıdaki komutu çalıştırın ve URL'yi açmak için Ctrl tuşunu basılı tutarken gösterilen URL'yi tıklayın:
    gcloud run services list \
     --format='value(URL)' \
     --filter='SERVICE:"codelab-o11y-service"'
    URL açıldığında 500 hatası alabilir veya şu mesajı görebilirsiniz:
    Sorry, this is just a placeholder...
    Bu, hizmetlerin dağıtımının tamamlanmadığı anlamına gelir. Birkaç dakika bekleyip sayfayı yenileyin. Sonunda, Köpeklerle İlgili Eğlenceli Bilgiler ile başlayan ve köpeklerle ilgili 10 eğlenceli bilgi içeren bir metin görürsünüz.

Farklı hayvanlar hakkında eğlenceli bilgiler edinmek için uygulamayla etkileşime geçmeyi deneyin. Bunu yapmak için URL'ye animal parametresini ekleyin. Örneğin, [ANIMAL] bir hayvan adı olmak üzere ?animal=[ANIMAL]. Örneğin, kedilerle ilgili 10 ilginç bilgi almak için ?animal=cat, deniz kaplumbağalarıyla ilgili 10 ilginç bilgi almak için ?animal=sea turtle ekleyin.

7. Vertex API çağrılarınızı denetleme

Google API çağrılarını denetlemek, "Belirli bir API'yi kim, nerede ve ne zaman çağırdı?" gibi soruların yanıtlarını sağlar. Uygulamanızda sorun giderirken, kaynak tüketimini incelerken veya yazılım adli analizi yaparken denetim önemlidir.

Denetleme günlükleri, yönetim ve sistem etkinliklerini izlemenin yanı sıra "veri okuma" ve "veri yazma" API işlemlerine yapılan çağrıları kaydetmenize olanak tanır. İçerik oluşturmak için yapılan Vertex AI isteklerini denetlemek üzere Cloud Console'da "Veri Okuma" denetleme günlüklerini etkinleştirmeniz gerekir.

  1. Cloud Console'da Denetleme Günlükleri sayfasını açmak için aşağıdaki düğmeyi tıklayın

  2. Sayfada bu laboratuvar için oluşturduğunuz projenin seçili olduğundan emin olun. Seçilen proje, hamburger menüsünün hemen sağındaki sayfanın sol üst köşesinde gösterilir:
    Google Cloud Console proje açılır listesi
    Gerekirse açılır listeden doğru projeyi seçin.
  3. Veri erişimi denetim günlükleri yapılandırması tablosundaki Hizmet sütununda Vertex AI API hizmetini bulun ve hizmet adının solundaki onay kutusunu işaretleyerek hizmeti seçin.
    Vertex AI API&#39;yi seçin
  4. Sağdaki bilgi panelinde "Veri Okundu" denetim türünü seçin.
    Veri okuma günlüklerini kontrol etme
  5. Kaydet'i tıklayın.

Denetleme günlükleri oluşturmak için hizmet URL'sini açın. Farklı sonuçlar almak için ?animal= parametresinin değerini değiştirirken sayfayı yenileyin.

Denetleme günlüklerini inceleme

  1. Cloud Console'da Günlük Gezgini sayfasını açmak için aşağıdaki düğmeyi tıklayın:

  2. Aşağıdaki filtreyi Sorgu bölmesine yapıştırın.
    LOG_ID("cloudaudit.googleapis.com%2Fdata_access") AND
protoPayload.serviceName="aiplatform.googleapis.com"
    Sorgu bölmesi, Günlük Gezgini sayfasının üst kısmında bulunan bir düzenleyicidir:
    Denetleme günlüklerini sorgulama
  3. Sorguyu çalıştır'ı tıklayın.
  4. Denetleme günlüğü girişlerinden birini seçin ve günlükte yakalanan bilgileri incelemek için alanları genişletin.
    Kullanılan yöntem ve model de dahil olmak üzere Vertex API çağrısı hakkında ayrıntıları görebilirsiniz. Ayrıca, çağıranın kimliğini ve hangi izinlerin çağrıyı yetkilendirdiğini de görebilirsiniz.

8. Üretken yapay zeka ile etkileşimleri kaydetme

Denetleme günlüklerinde API isteği parametrelerini veya yanıt verilerini bulamazsınız. Ancak bu bilgiler, uygulama ve iş akışı analizinde sorun giderme için önemli olabilir. Bu adımda, uygulama günlüğü ekleyerek bu boşluğu dolduruyoruz.

Uygulama, uygulama günlüklerini standart çıkışa yazdırmak için Spring Boot ile Logback'i kullanır. Bu yöntemde, standart çıkışa yazdırılan bilgileri yakalama ve bunları otomatik olarak Cloud Logging'e aktarma özelliği için Cloud Run kullanılır. Bilgilerin yapılandırılmış veri olarak yakalanabilmesi için yazdırılan günlüklerin buna göre biçimlendirilmesi gerekir. Uygulamaya yapılandırılmış günlük kaydı özellikleri eklemek için aşağıdaki talimatları uygulayın.

  1. Tarayıcınızda "Cloud Shell" penceresine (veya sekmesine) dönün.
  2. Cloud Shell Düzenleyici'de yeni bir dosya LoggingEventGoogleCloudEncoder.java oluşturup açın:
    cloudshell edit "${HOME}/codelab-o11y/src/main/java/com/example/demo/LoggingEventGoogleCloudEncoder.java"
  3. Günlüğü, Google Cloud yapılandırılmış günlük biçimine uygun olarak dizeleştirilmiş bir JSON olarak kodlayan Logback kodlayıcıyı uygulamak için aşağıdaki kodu kopyalayıp yapıştırın:
    package com.example.demo;

import static ch.qos.logback.core.CoreConstants.UTF_8_CHARSET;

import java.time.Instant;
import ch.qos.logback.core.encoder.EncoderBase;
import ch.qos.logback.classic.Level;
import ch.qos.logback.classic.spi.ILoggingEvent;
import java.util.HashMap;

import com.google.gson.Gson;

public class LoggingEventGoogleCloudEncoder extends EncoderBase<ILoggingEvent>  {
    private static final byte[] EMPTY_BYTES = new byte[0];
    private final Gson gson = new Gson();

    @Override
    public byte[] headerBytes() {
        return EMPTY_BYTES;
    }

    @Override
    public byte[] encode(ILoggingEvent e) {
        var timestamp = Instant.ofEpochMilli(e.getTimeStamp());
        var fields = new HashMap<String, Object>() {
            {
                put("timestamp", timestamp.toString());
                put("severity", severityFor(e.getLevel()));
                put("message", e.getMessage());
            }
        };
        var params = e.getKeyValuePairs();
        if (params != null && params.size() > 0) {
            params.forEach(kv -> fields.putIfAbsent(kv.key, kv.value));
        }
        var data = gson.toJson(fields) + "\n";
        return data.getBytes(UTF_8_CHARSET);
    }

    @Override
    public byte[] footerBytes() {
        return EMPTY_BYTES;
    }

    private static String severityFor(Level level) {
        switch (level.toInt()) {
            case Level.TRACE_INT:
            return "DEBUG";
            case Level.DEBUG_INT:
            return "DEBUG";
            case Level.INFO_INT:
            return "INFO";
            case Level.WARN_INT:
            return "WARNING";
            case Level.ERROR_INT:
            return "ERROR";
            default:
            return "DEFAULT";
        }
    }
}
  4. Cloud Shell Düzenleyici'de yeni bir dosya logback.xml oluşturup açın:
    cloudshell edit "${HOME}/codelab-o11y/src/main/resources/logback.xml"
  5. Logback'i, günlükleri standart çıkışa yazdıran Logback ekleyicisiyle kodlayıcıyı kullanacak şekilde yapılandırmak için aşağıdaki XML'i kopyalayıp yapıştırın:
    <?xml version="1.0" encoding="UTF-8"?>
<configuration debug="true">
    <appender name="Console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="com.example.demo.LoggingEventGoogleCloudEncoder"/>
    </appender>

    <root level="info">
        <appender-ref ref="Console" />
    </root>
</configuration>
  6. DemoApplication.java dosyasını Cloud Shell Düzenleyici'de yeniden açın:
    cloudshell edit "${HOME}/codelab-o11y/src/main/java/com/example/demo/DemoApplication.java"
  7. Üretken yapay zeka isteğini ve yanıtını günlüğe kaydetmek için düzenleyicideki kodu aşağıda gösterilen sürümle değiştirin. Kodu değiştirmek için dosyanın içeriğini silin ve aşağıdaki kodu düzenleyiciye kopyalayın:
    package com.example.demo;

import java.io.IOException;
import java.util.Collections;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import com.google.cloud.ServiceOptions;
import com.google.cloud.vertexai.VertexAI;
import com.google.cloud.vertexai.api.GenerateContentResponse;
import com.google.cloud.vertexai.generativeai.GenerativeModel;
import com.google.cloud.vertexai.generativeai.ResponseHandler;

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        String port = System.getenv().getOrDefault("PORT", "8080");
        SpringApplication app = new SpringApplication(DemoApplication.class);
        app.setDefaultProperties(Collections.singletonMap("server.port", port));
        app.run(args);
    }
}

@RestController
class HelloController {
    private final String projectId = ServiceOptions.getDefaultProjectId();
    private VertexAI vertexAI;
    private GenerativeModel model;
    private final Logger LOGGER = LoggerFactory.getLogger(HelloController.class);

    @PostConstruct
    public void init() {
        vertexAI = new VertexAI(projectId, "us-central1");
        model = new GenerativeModel("gemini-1.5-flash", vertexAI);
    }

    @PreDestroy
    public void destroy() {
        vertexAI.close();
    }

    @GetMapping("/")
    public String getFacts(@RequestParam(defaultValue = "dog") String animal) throws IOException {
        String prompt = "Give me 10 fun facts about " + animal + ". Return this as html without backticks.";
        GenerateContentResponse response = model.generateContent(prompt);
        LOGGER.atInfo()
                .addKeyValue("animal", animal)
                .addKeyValue("prompt", prompt)
                .addKeyValue("response", response)
                .log("Content is generated");
        return ResponseHandler.getText(response);
    }
}

Cloud Shell Düzenleyici, birkaç saniye sonra değişikliklerinizi otomatik olarak kaydeder.

Üretken yapay zeka uygulamasının kodunu Cloud Run'a dağıtma

  1. Terminal penceresinde, uygulamanın kaynak kodunu Cloud Run'a dağıtma komutunu çalıştırın.
    gcloud run deploy codelab-o11y-service \
     --source="${HOME}/codelab-o11y/" \
     --region=us-central1 \
     --allow-unauthenticated
    Aşağıdaki gibi bir istem görürseniz komutun yeni bir depo oluşturacağını bildirir. Enter simgesini tıklayın.
    Deploying from source requires an Artifact Registry Docker repository to store built containers.
A repository named [cloud-run-source-deploy] in region [us-central1] will be created.

Do you want to continue (Y/n)?
    Dağıtım işlemi birkaç dakika sürebilir. Dağıtım işlemi tamamlandıktan sonra aşağıdaki gibi bir çıkış görürsünüz:
    Service [codelab-o11y-service] revision [codelab-o11y-service-00001-t2q] has been deployed and is serving 100 percent of traffic.
Service URL: https://codelab-o11y-service-12345678901.us-central1.run.app
  2. Görüntülenen Cloud Run hizmeti URL'sini tarayıcınızdaki ayrı bir sekmeye veya pencereye kopyalayın. Alternatif olarak, hizmet URL'sini yazdırmak için terminalde aşağıdaki komutu çalıştırın ve URL'yi açmak için Ctrl tuşunu basılı tutarken gösterilen URL'yi tıklayın:
    gcloud run services list \
     --format='value(URL)' \
     --filter='SERVICE:"codelab-o11y-service"'
    URL açıldığında 500 hatası alabilir veya şu mesajı görebilirsiniz:
    Sorry, this is just a placeholder...
    Bu, hizmetlerin dağıtımının tamamlanmadığı anlamına gelir. Birkaç dakika bekleyip sayfayı yenileyin. Sonunda, Köpeklerle İlgili Eğlenceli Bilgiler ile başlayan ve köpeklerle ilgili 10 eğlenceli bilgi içeren bir metin görürsünüz.

Uygulama günlüklerini oluşturmak için hizmet URL'sini açın. Farklı sonuçlar almak için ?animal= parametresinin değerini değiştirirken sayfayı yenileyin.
Uygulama günlüklerini görmek için şunları yapın:

  1. Cloud Console'da Günlük Gezgini sayfasını açmak için aşağıdaki düğmeyi tıklayın:

  2. Aşağıdaki filtreyi Sorgu bölmesine yapıştırın (Günlük Gezgini arayüzünde 2. adım):
    LOG_ID("run.googleapis.com%2Fstdout") AND
severity=DEBUG
  3. Sorguyu çalıştır'ı tıklayın.

Sorgunun sonucu, güvenlik derecelendirmeleri de dahil olmak üzere istem ve Vertex AI yanıtını içeren günlükleri gösterir.

9. Üretken yapay zeka ile etkileşimleri sayma

Cloud Run, dağıtılan hizmetleri izlemek için kullanılabilecek yönetilen metrikler yazar. Kullanıcı tarafından yönetilen izleme metrikleri, veriler ve metrik güncelleme sıklığı üzerinde daha fazla kontrol sağlar. Bu tür bir metriği uygulamak için veri toplayıp Cloud Monitoring'e yazan bir kod yazılması gerekir. OpenTelemetry SDK'yı kullanarak nasıl uygulayacağınızı öğrenmek için sonraki (isteğe bağlı) adıma bakın.

Bu adımda, kullanıcı metriğini kodda uygulamanın alternatifi olan günlüğe dayalı metrikler gösterilmektedir. Günlük tabanlı metrikler, uygulamanızın Cloud Logging'e yazdığı günlük girişlerinden izleme metrikleri oluşturmanıza olanak tanır. Sayaç türünde günlük tabanlı bir metrik tanımlamak için önceki adımda uyguladığımız uygulama günlüklerini kullanacağız. Bu metrik, Vertex API'ye yapılan başarılı çağrıların sayısını gösterir.

  1. Önceki adımda kullandığımız Günlük Gezgini penceresine bakın. Sorgu bölmesinde İşlemler açılır menüsünü bulun ve açmak için tıklayın. Menüyü bulmak için aşağıdaki ekran görüntüsüne bakın:
    İşlemler açılır menüsünü içeren sorgu sonuçları araç çubuğu
  2. Açılan menüde Günlüğe dayalı metrik oluştur panelini açmak için Metrik oluştur'u seçin.
  3. Günlük tabanlı metrik oluştur panelinde yeni bir sayaç metriği yapılandırmak için aşağıdaki adımları uygulayın:
    1. Metrik türünü ayarlayın: Sayaç'ı seçin.
    2. Ayrıntılar bölümünde aşağıdaki alanları ayarlayın:
      • Günlük metriği adı: Adı model_interaction_count olarak ayarlayın. Adlandırmayla ilgili bazı kısıtlamalar vardır. Ayrıntılar için adlandırmayla ilgili kısıtlamalar Sorun Giderme bölümüne bakın.
      • Açıklama: Metrik için bir açıklama girin. Örneğin, Number of log entries capturing successful call to model inference.
      • Birimler: Bu alanı boş bırakın veya 1 rakamını girin.
    3. Filtre seçimi bölümündeki değerleri olduğu gibi bırakın. Filtre oluştur alanının, uygulama günlüklerini görmek için kullandığımız filtreyle aynı olduğunu unutmayın.
    4. (İsteğe bağlı) Her hayvan için yapılan çağrı sayısını hesaplamaya yardımcı olan bir etiket ekleyin. NOT: Bu etiket, metriğin kardinalitesini büyük ölçüde artırabilir ve üretimde kullanılması önerilmez:
      1. Etiket ekle'yi tıklayın.
      2. Etiketler bölümünde aşağıdaki alanları ayarlayın:
        • Etiket adı: Adı animal olarak ayarlayın.
        • Açıklama: Etiketin açıklamasını girin. Örneğin, Animal parameter.
        • Etiket türü: STRING seçeneğini belirleyin.
        • Alan adı: Tür jsonPayload.animal.
        • Regular expression (Normal ifade): Boş bırakın.
      3. Bitti'yi tıklayın
    5. Metriği oluşturmak için Metrik oluştur'u tıklayın.

Ayrıca, gcloud logging metrics create CLI komutunu kullanarak veya google_logging_metric Terraform kaynağıyla Günlük tabanlı metrikler sayfasından günlük tabanlı metrik oluşturabilirsiniz.

Metrik verileri oluşturmak için hizmet URL'sini açın. Modele birden fazla istek göndermek için açılan sayfayı birkaç kez yenileyin. Daha önce olduğu gibi, parametrede farklı hayvanlar kullanmayı deneyin.

Günlük tabanlı metrik verilerini aramak için PromQL sorgusunu girin. PromQL sorgusu girmek için aşağıdakileri yapın:

  1. Cloud Console'da Metrik Gezgini sayfasını açmak için aşağıdaki düğmeyi tıklayın:

  2. Sorgu oluşturucu bölmesinin araç çubuğunda, adı < > MQL veya < > PromQL olan düğmeyi seçin. Düğmenin konumunu aşağıdaki resimde görebilirsiniz.
    Metrik Gezgini&#39;ndeki MQL düğmesinin konumu
  3. Dil açma/kapatma düğmesinde PromQL'nin seçili olduğunu doğrulayın. Dil değiştirme düğmesi, sorgunuzu biçimlendirmenize olanak tanıyan araç çubuğunda yer alır.
  4. Sorgunuzu Sorgular düzenleyicisine girin:
    sum(rate(logging_googleapis_com:user_model_interaction_count{monitored_resource="cloud_run_revision"}[${__interval}]))
    PromQL'i kullanma hakkında daha fazla bilgi için Cloud Monitoring'de PromQL bölümüne bakın.
  5. Run Query'yi (Sorguyu Çalıştır) tıklayın. Şu ekran görüntüsüne benzer bir çizgi grafik görürsünüz:
    Sorgulanan metrikleri göster

    Otomatik çalıştır açma/kapatma düğmesi etkinleştirildiğinde Sorguyu Çalıştır düğmesinin gösterilmediğini unutmayın.

10. (İsteğe bağlı) İzleme ve izleme için Open Telemetry'yi kullanma

Önceki adımda belirtildiği gibi, OpenTelemetry (Otel) SDK'sını kullanarak metrikleri uygulayabilirsiniz. Çok hizmetli mimarilerde OTel kullanılması önerilen bir uygulamadır. Bu adımda, bir Spring Boot uygulamasına OTel enstrümantasyonunun nasıl ekleneceği gösterilmektedir. Bu adımda şunları yapacaksınız:

  • Spring Boot uygulamasını otomatik izleme özellikleriyle izleme
  • Başarılı model çağrılarının sayısını izlemek için sayaç metriği uygulama
  • İzlemeyi uygulama günlükleriyle ilişkilendirme

Ürün düzeyindeki hizmetler için önerilen mimari, birden fazla hizmetten tüm gözlemlenebilirlik verilerini toplamak ve almak için OTel toplayıcı kullanmaktır. Bu adımdaki kod, basitlik açısından toplayıcıyı kullanmaz. Bunun yerine, verileri doğrudan Google Cloud'a yazan OTel dışa aktarma işlemlerini kullanır.

OTel bileşenleri ve otomatik izleme ile Spring Boot uygulamasını ayarlama

  1. Tarayıcınızda "Cloud Shell" penceresine (veya sekmesine) dönün.
  2. Terminalde, application.permissions dosyasını ek yapılandırma parametreleriyle güncelleyin:
    cat >> "${HOME}/codelab-o11y/src/main/resources/application.properties" << EOF
otel.logs.exporter=none
otel.traces.exporter=google_cloud_trace
otel.metrics.exporter=google_cloud_monitoring
otel.resource.attributes.service.name=codelab-o11y-service
otel.traces.sampler=always_on
EOF
    Bu parametreler, gözlemlenebilirlik verilerinin Cloud Trace ve Cloud Monitoring'e aktarılmasını tanımlar ve tüm izlerin örneklenmesini zorunlu kılar.
  3. Gerekli OpenTelemetry bağımlılıklarını pom.xml dosyasına ekleyin:
    sed -i 's/<dependencies>/<dependencies>\
\
        <dependency>\
            <groupId>io.opentelemetry.instrumentation<\/groupId>\
            <artifactId>opentelemetry-spring-boot-starter<\/artifactId>\
        <\/dependency>\
        <dependency>\
            <groupId>com.google.cloud.opentelemetry<\/groupId>\
            <artifactId>exporter-auto<\/artifactId>\
            <version>0.33.0-alpha<\/version>\
        <\/dependency>\
        <dependency>\
            <groupId>com.google.cloud.opentelemetry<\/groupId>\
            <artifactId>exporter-trace<\/artifactId>\
            <version>0.33.0<\/version>\
        <\/dependency>\
        <dependency>\
            <groupId>com.google.cloud.opentelemetry<\/groupId>\
            <artifactId>exporter-metrics<\/artifactId>\
            <version>0.33.0<\/version>\
        <\/dependency>\
/g' "${HOME}/codelab-o11y/pom.xml"
  4. pom.xml dosyasına OpenTelemetry BOM'u ekleyin:
    sed -i 's/<\/properties>/<\/properties>\
    <dependencyManagement>\
        <dependencies>\
            <dependency>\
                <groupId>io.opentelemetry.instrumentation<\/groupId>\
                <artifactId>opentelemetry-instrumentation-bom<\/artifactId>\
                <version>2.12.0<\/version>\
                <type>pom<\/type>\
                <scope>import<\/scope>\
            <\/dependency>\
        <\/dependencies>\
    <\/dependencyManagement>\
/g' "${HOME}/codelab-o11y/pom.xml"
  5. DemoApplication.java dosyasını Cloud Shell Düzenleyici'de yeniden açın:
    cloudshell edit "${HOME}/codelab-o11y/src/main/java/com/example/demo/DemoApplication.java"
  6. Mevcut kodu, bir performans metriğini artıran sürümle değiştirin. Kodu değiştirmek için dosyanın içeriğini silin ve aşağıdaki kodu düzenleyiciye kopyalayın:
    package com.example.demo;

import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.api.common.Attributes;
import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.api.metrics.LongCounter;

import java.io.IOException;
import java.util.Collections;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import com.google.cloud.ServiceOptions;
import com.google.cloud.vertexai.VertexAI;
import com.google.cloud.vertexai.api.GenerateContentResponse;
import com.google.cloud.vertexai.generativeai.GenerativeModel;
import com.google.cloud.vertexai.generativeai.ResponseHandler;


@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        String port = System.getenv().getOrDefault("PORT", "8080");
        SpringApplication app = new SpringApplication(DemoApplication.class);
        app.setDefaultProperties(Collections.singletonMap("server.port", port));
        app.run(args);
    }
}

@RestController
class HelloController {
    private final String projectId = ServiceOptions.getDefaultProjectId();
    private VertexAI vertexAI;
    private GenerativeModel model;
    private final Logger LOGGER = LoggerFactory.getLogger(HelloController.class);
    private static final String INSTRUMENTATION_NAME = "genai-o11y/java/workshop/example";
    private static final AttributeKey<String> ANIMAL = AttributeKey.stringKey("animal");
    private final LongCounter counter;

    public HelloController(OpenTelemetry openTelemetry) {
        this.counter = openTelemetry.getMeter(INSTRUMENTATION_NAME)
                .counterBuilder("model_call_counter")
                .setDescription("Number of successful model calls")
                .build();
    }

    @PostConstruct
    public void init() {
        vertexAI = new VertexAI(projectId, "us-central1");
        model = new GenerativeModel("gemini-1.5-flash", vertexAI);
    }

    @PreDestroy
    public void destroy() {
        vertexAI.close();
    }

    @GetMapping("/")
    public String getFacts(@RequestParam(defaultValue = "dog") String animal) throws IOException {
        String prompt = "Give me 10 fun facts about " + animal + ". Return this as html without backticks.";
        GenerateContentResponse response = model.generateContent(prompt);
        LOGGER.atInfo()
                .addKeyValue("animal", animal)
                .addKeyValue("prompt", prompt)
                .addKeyValue("response", response)
                .log("Content is generated");
        counter.add(1, Attributes.of(ANIMAL, animal));
        return ResponseHandler.getText(response);
    }
}
  7. LoggingEventGoogleCloudEncoder.java dosyasını Cloud Shell Düzenleyici'de yeniden açın:
    cloudshell edit "${HOME}/codelab-o11y/src/main/java/com/example/demo/LoggingEventGoogleCloudEncoder.java"
  8. Mevcut kodu, yazılan günlükleri izleme özelliklerini ekleyen sürümle değiştirin. Özelliklerin eklenmesi, günlüklerin doğru izleme aralıklarıyla ilişkilendirilmesini sağlar. Kodu değiştirmek için dosyanın içeriğini silin ve aşağıdaki kodu düzenleyiciye kopyalayın:
    package com.example.demo;

import static ch.qos.logback.core.CoreConstants.UTF_8_CHARSET;

import java.time.Instant;
import java.util.HashMap;

import ch.qos.logback.core.encoder.EncoderBase;
import ch.qos.logback.classic.Level;
import ch.qos.logback.classic.spi.ILoggingEvent;
import com.google.cloud.ServiceOptions;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.SpanContext;
import io.opentelemetry.context.Context;

import com.google.gson.Gson;


public class LoggingEventGoogleCloudEncoder extends EncoderBase<ILoggingEvent>  {
    private static final byte[] EMPTY_BYTES = new byte[0];
    private final Gson gson;
    private final String projectId;
    private final String tracePrefix;


    public LoggingEventGoogleCloudEncoder() {
        this.gson = new Gson();
        this.projectId = lookUpProjectId();
        this.tracePrefix = "projects/" + (projectId == null ? "" : projectId) + "/traces/";
    }

    private static String lookUpProjectId() {
        return ServiceOptions.getDefaultProjectId();
    }

    @Override
    public byte[] headerBytes() {
        return EMPTY_BYTES;
    }

    @Override
    public byte[] encode(ILoggingEvent e) {
        var timestamp = Instant.ofEpochMilli(e.getTimeStamp());
        var fields = new HashMap<String, Object>() {
            {
                put("timestamp", timestamp.toString());
                put("severity", severityFor(e.getLevel()));
                put("message", e.getMessage());
                SpanContext context = Span.fromContext(Context.current()).getSpanContext();
                if (context.isValid()) {
                    put("logging.googleapis.com/trace", tracePrefix + context.getTraceId());
                    put("logging.googleapis.com/spanId", context.getSpanId());
                    put("logging.googleapis.com/trace_sampled", Boolean.toString(context.isSampled()));
                }
            }
        };
        var params = e.getKeyValuePairs();
        if (params != null && params.size() > 0) {
            params.forEach(kv -> fields.putIfAbsent(kv.key, kv.value));
        }
        var data = gson.toJson(fields) + "\n";
        return data.getBytes(UTF_8_CHARSET);
    }

    @Override
    public byte[] footerBytes() {
        return EMPTY_BYTES;
    }

    private static String severityFor(Level level) {
        switch (level.toInt()) {
            case Level.TRACE_INT:
            return "DEBUG";
            case Level.DEBUG_INT:
            return "DEBUG";
            case Level.INFO_INT:
            return "INFO";
            case Level.WARN_INT:
            return "WARNING";
            case Level.ERROR_INT:
            return "ERROR";
            default:
            return "DEFAULT";
        }
    }
}

Cloud Shell Düzenleyici, birkaç saniye sonra değişikliklerinizi otomatik olarak kaydeder.

Üretken yapay zeka uygulamasının kodunu Cloud Run'a dağıtma

  1. Terminal penceresinde, uygulamanın kaynak kodunu Cloud Run'a dağıtma komutunu çalıştırın.
    gcloud run deploy codelab-o11y-service \
     --source="${HOME}/codelab-o11y/" \
     --region=us-central1 \
     --allow-unauthenticated
    Aşağıdaki gibi bir istem görürseniz komutun yeni bir depo oluşturacağını bildirir. Enter simgesini tıklayın.
    Deploying from source requires an Artifact Registry Docker repository to store built containers.
A repository named [cloud-run-source-deploy] in region [us-central1] will be created.

Do you want to continue (Y/n)?
    Dağıtım işlemi birkaç dakika sürebilir. Dağıtım işlemi tamamlandıktan sonra aşağıdaki gibi bir çıkış görürsünüz:
    Service [codelab-o11y-service] revision [codelab-o11y-service-00001-t2q] has been deployed and is serving 100 percent of traffic.
Service URL: https://codelab-o11y-service-12345678901.us-central1.run.app
  2. Görüntülenen Cloud Run hizmeti URL'sini tarayıcınızdaki ayrı bir sekmeye veya pencereye kopyalayın. Alternatif olarak, hizmet URL'sini yazdırmak için terminalde aşağıdaki komutu çalıştırın ve URL'yi açmak için Ctrl tuşunu basılı tutarken gösterilen URL'yi tıklayın:
    gcloud run services list \
     --format='value(URL)' \
     --filter='SERVICE:"codelab-o11y-service"'
    URL açıldığında 500 hatası alabilir veya şu mesajı görebilirsiniz:
    Sorry, this is just a placeholder...
    Bu, hizmetlerin dağıtımının tamamlanmadığı anlamına gelir. Birkaç dakika bekleyip sayfayı yenileyin. Sonunda, Köpeklerle İlgili Eğlenceli Bilgiler ile başlayan ve köpeklerle ilgili 10 eğlenceli bilgi içeren bir metin görürsünüz.

Telemetri verileri oluşturmak için hizmet URL'sini açın. Farklı sonuçlar almak için ?animal= parametresinin değerini değiştirirken sayfayı yenileyin.

Uygulama izlerini keşfetme

  1. Cloud Console'da Trace Explorer sayfasını açmak için aşağıdaki düğmeyi tıklayın:

  2. En son izlerden birini seçin. Aşağıdaki ekran görüntüsünde gösterildiği gibi 5 veya 6 aralık görmeniz gerekir.
    Trace Gezgini&#39;nde uygulama aralığının görünümü
  3. Etkinlik işleyiciye (fun_facts yöntemi) yapılan çağrıyı izleyen aralığı bulun. Bu, / adlı son aralık olacaktır.
  4. İzleme ayrıntıları bölmesinde Günlükler ve etkinlikler'i seçin. Bu belirli aralıkla ilişkili uygulama günlüklerini görürsünüz. Korelasyon, izdeki ve günlükteki iz ve aralık kimlikleri kullanılarak algılanır. İstem ve Vertex API'nin yanıtını yazan uygulama günlüğünü görmeniz gerekir.

Karşı metriği inceleme

  1. Cloud Console'da Metrik Gezgini sayfasını açmak için aşağıdaki düğmeyi tıklayın:

  2. Sorgu oluşturucu bölmesinin araç çubuğunda, adı < > MQL veya < > PromQL olan düğmeyi seçin. Düğmenin konumunu aşağıdaki resimde görebilirsiniz.
    Metrik Gezgini&#39;ndeki MQL düğmesinin konumu
  3. Dil açma/kapatma düğmesinde PromQL'nin seçili olduğunu doğrulayın. Dil değiştirme düğmesi, sorgunuzu biçimlendirmenize olanak tanıyan araç çubuğunda yer alır.
  4. Sorgunuzu Sorgular düzenleyicisine girin:
    sum(rate(workload_googleapis_com:model_call_counter{monitored_resource="generic_task"}[${__interval}]))
  5. Run Query'yi (Sorgu Çalıştır) tıklayın.Auto-run (Otomatik çalıştırma) açma/kapatma düğmesi etkinleştirildiğinde Run Query düğmesi gösterilmez.

11. (İsteğe bağlı) Günlüklerdeki hassas bilgileri karartma

10. adımda, uygulamanın Gemini modeliyle etkileşimi hakkında bilgi kaydettik. Bu bilgiler arasında hayvanın adı, asıl istem ve modelin yanıtı yer alıyordu. Bu bilgilerin günlükte saklanması güvenli olsa da diğer birçok senaryo için bu durum geçerli değildir. İstem, kullanıcının depolanmasını istemediği kişisel veya hassas bilgiler içerebilir. Bu sorunu çözmek için Cloud Logging'e yazılan hassas verileri karartabilirsiniz. Kod değişikliklerini en aza indirmek için aşağıdaki çözüm önerilir.

  1. Gelen günlük girişlerini depolamak için bir PubSub konusu oluşturun.
  2. Alınan günlükleri Pub/Sub konusuna yönlendiren bir günlük havuzu oluşturun.
  3. Aşağıdaki adımları uygulayarak Pub/Sub konusuna yönlendirilen günlükleri değiştiren bir Dataflow ardışık düzeni oluşturun:
    1. Pub/Alt konusundaki bir günlük girişini okuma
    2. DLP inceleme API'sini kullanarak girişin yükünde hassas bilgiler olup olmadığını inceleme
    3. VKÖ redaksiyon yöntemlerinden birini kullanarak yükteki hassas bilgileri redakte edin.
    4. Karartılmış günlük girişini Cloud Logging'e yazma
  4. Ardışık düzeni dağıtma

12. (İsteğe bağlı) Temizleme

Bu codelab'de kullanılan kaynaklar ve API'ler için ücretlendirilme riskini önlemek amacıyla laboratuvarı tamamladıktan sonra temizlik yapmanız önerilir. Faturalandırılmanın önüne geçmenin en kolay yolu, codelab için oluşturduğunuz projeyi silmektir.

  1. Projeyi silmek için terminalde proje silme komutunu çalıştırın:
    PROJECT_ID=$(gcloud config get-value project)
gcloud projects delete ${PROJECT_ID} --quiet
    Cloud projenizi sildiğinizde, bu projede kullanılan tüm kaynaklar ve API'ler için faturalandırma durdurulur. PROJECT_ID yerine proje kimliğinizin yazıldığı şu mesajı görürsünüz:
    Deleted [https://cloudresourcemanager.googleapis.com/v1/projects/PROJECT_ID].

You can undo this operation for a limited period by running the command below.
    $ gcloud projects undelete PROJECT_ID

See https://cloud.google.com/resource-manager/docs/creating-managing-projects for information on shutting down projects.
  2. (İsteğe bağlı) Hata alırsanız laboratuvar sırasında kullandığınız proje kimliğini bulmak için 5. adıma bakın. Bunu ilk talimattaki komutla değiştirin. Örneğin, proje kimliğiniz lab-example-project ise komut şu şekilde olur:
    gcloud projects delete lab-project-id-example --quiet

13. Tebrikler

Bu laboratuvarda, tahminlerde bulunmak için Gemini modelini kullanan bir üretken yapay zeka uygulaması oluşturdunuz. Ayrıca uygulamayı temel izleme ve günlük kaydı özellikleriyle donattık. Uygulamayı ve kaynak kodundaki değişiklikleri Cloud Run'a dağıttınız. Ardından, uygulamanın performansını izlemek için Google Cloud Observability ürünlerini kullanırsınız. Böylece uygulamanın güvenilirliğinden emin olabilirsiniz.

Bugün kullandığınız ürünleri iyileştirmek için kullanıcı deneyimi (UX) araştırmasına katılmak isterseniz buradan kaydolun.

Öğrenmeye devam etmek için kullanabileceğiniz bazı seçenekler: