spring boot opentelemetry

Spring Boot opentelemetry

ตัวชี้วัด

Spring Boot Actuator ให้การจัดการการพึ่งพาและการกำหนดค่าอัตโนมัติสำหรับไมโครมิเตอร์ซึ่งให้บริการด้านหน้าที่สะดวกกว่าระบบการตรวจสอบที่แตกต่างกันมากมาย หนึ่งในนั้นคือ opentelemetry

นักพัฒนา Spring Boot สามารถเปิดใช้งานแอพพลิเคชั่นของพวกเขาในการส่งออกตัวชี้วัดผ่านโปรโตคอล OTLP ไปยังแบ็กเอนด์ OpentElemetry โดยการเพิ่มสปริงแอคชูเอเตอร์และการพึ่งพา opentelemetry เฉพาะจากไมโครมิเตอร์ไปยังโครงการของพวกเขา

dependencies {
    implementation ' org.springframework.boot:spring-boot-starter-actuator '
    runtimeOnly ' io.micrometer:micrometer-registry-otlp '
    .. .
}

ผู้ส่งออกที่จัดทำโดยไมโครมิเตอร์รีจิสทรี OTLP เป็นผู้ส่งออก HTTP และสามารถกำหนดค่าผ่านคุณสมบัติได้ด้วยการกำหนดค่าอัตโนมัติสำหรับ opentelemetry

 management :
  otlp :
    metrics :
      export :
        url : http://localhost:4318/v1/metrics
        step : 5s

OpentElemetry รองรับคู่คีย์/ค่าเพิ่มเติม (เรียกว่า resource attributes ) ที่จะรวมอยู่ในข้อมูล telemetry Spring Boot Actuator ให้การกำหนดค่าอัตโนมัติสำหรับผู้ที่และทำให้สามารถเพิ่มแอตทริบิวต์ทรัพยากรใหม่ผ่านคุณสมบัติ

 management :
  opentelemetry :
    resource-attributes :
      cluster : local
      " service.name " : ${spring.application.name}

ฉันสร้างแอปพลิเคชั่นตัวอย่างเพื่อแสดงการตั้งค่านี้

ปัญหา: ผู้ส่งออกตัวชี้วัด OTLP ไม่สามารถกำหนดค่าได้ผ่าน OpentElemetry

โมดูล Micrometer Registry OTLP ใช้ไคลเอนต์ HTTP ที่เข้ากันได้กับ OTLP เพื่อส่งออกตัวชี้วัดไปยังแบ็กเอนด์ OpentElemetry ภายใน OtlpMeterRegistry ใช้วัตถุ HttpSender ส่วนตัวเพื่อกำหนดค่าไคลเอนต์ HTTP ประโยชน์ของวิธีการนี้คือโมดูลมีน้ำหนักเบาและไม่ต้องการการพึ่งพาใด ๆ ใน Opentelemetry SDK มันใช้เฉพาะไลบรารี io.opentelemetry.proto ซึ่งให้การกำหนดค่า protobuf สำหรับ opentelemetry

ในทางกลับกันวิธีการดังกล่าวหมายความว่า:

• เป็นไปไม่ได้ที่จะกำหนดค่าผู้ส่งออกเมทริกผ่านการกำหนดค่า OpentElemetry มาตรฐาน
• ไม่สามารถกำหนดค่าการบีบอัดได้
• มันเป็นไปไม่ได้ที่จะแบ่งปันการกำหนดค่า opentelemetry ในสปริงบูตระหว่างตัวชี้วัดและร่องรอย

OpenTelemetryAutoConfiguration ใหม่ทั่วไปใน Spring Boot 3.2 Autoconfigures ถั่ว OpenTelemetry และทำให้สามารถกำหนดค่าถั่ว SdkMeterProvider ได้ จะเป็นอย่างไรถ้าไมโครมิเตอร์สามารถใช้สิ่งนั้นสำหรับการตั้งค่าผู้ส่งออก OpentElemetry

วิธีแก้ปัญหาที่เป็นไปได้:

• อัปเดตโมดูล OTLP รีจิสทรีไมโครมิเตอร์ที่มีอยู่เพื่อใช้งาน MeterRegistry ที่ยอมรับวัตถุ OpenTelemetry สำหรับการกำหนดค่า (คล้ายกับ OpenTelemetryMeterRegistry ที่ใช้โดยไลบรารีเครื่องมือ OpentElemetry Java) หากจำเป็นต้องใช้ความเข้ากันได้ย้อนหลังการใช้งานใหม่จะต้องอยู่ร่วมกับสิ่งที่มีอยู่เดิม (อาจเป็นธงฟีเจอร์ที่สามารถสลับระหว่างทั้งสองได้?);
• สร้างโมดูล OpentElemetry รีจิสทรีไมโครมิเตอร์ใหม่เพื่อใช้สิ่งที่อธิบายไว้ในจุดก่อนหน้า แต่ไม่มีปัญหากับความเข้ากันได้แบบย้อนหลัง

ฉันได้ส่งปัญหาไปยังโครงการไมโครมิเตอร์และแบ่งปันคำแนะนำเหล่านี้ การสร้าง (หรืออัปเดต) โมดูลดังกล่าวจะทำให้สามารถใช้ OpenTelemetryAutoConfiguration ได้อีกครั้งใน Spring Boot 3.2 สำหรับทั้งตัวชี้วัดและร่องรอย (และในอนาคตสำหรับบันทึกเช่นกัน)

• ปัญหามีอยู่แล้วในโครงการ Spring Boot เพื่อกำหนดค่า autoconfigure ถั่ว SdkMeterProvider และโดยทั่วไปสำหรับการใช้ตัวชี้วัดกับ opentelemetry แต่เราขาดการรองรับไมโครมิเตอร์ก่อนที่จะทำได้
• นอกจากนี้ยังจะทำให้สามารถเปลี่ยนการใช้งานไคลเอนต์ระหว่าง HTTP และ GRPC โดยใช้วิธีการ OpentElemetry มาตรฐาน (เช่นการกำหนดค่า OtlpHttpMetricExporter หรือ OtlpGrpcMetricExporter )
• ในที่สุดมันจะช่วยให้นักพัฒนาซอฟต์แวร์ใช้ไมโครมิเตอร์ในแอปพลิเคชันพร้อมกับตัวแทน Java Opentelemetry หรือโดยทั่วไปคือเครื่องมือวัด Java Opentelemetry โครงการเหล่านั้นในปัจจุบันรักษาความกระฉับกระเฉงระหว่างไมโครมิเตอร์และ opentelemetry ชิมนั้นอาจไม่จำเป็นอีกต่อไป ดังนั้นการเปลี่ยนแปลงดังกล่าวจะช่วยลดปริมาณงานในการบำรุงรักษาเครื่องมือ Opentelemetry Java ที่เข้ากันได้กับไมโครมิเตอร์

สำหรับบริบทเพิ่มเติมเกี่ยวกับความท้าทายในปัจจุบันโปรดดูที่ปัญหานี้ในโครงการ Spring Boot

ร่องรอย

Spring Boot Actuator ให้การจัดการการพึ่งพาและการกำหนดค่าอัตโนมัติสำหรับการติดตามไมโครมิเตอร์ซึ่งให้บริการด้านหน้าที่สะดวกกว่าแบ็กเอนด์การติดตามแบบกระจายที่แตกต่างกัน หนึ่งในนั้นคือ opentelemetry

นักพัฒนา Spring Boot สามารถเปิดใช้งานแอปพลิเคชันของพวกเขาเพื่อส่งออกร่องรอยผ่านโปรโตคอล OTLP ไปยังแบ็กเอนด์ OpentElemetry โดยการเพิ่มสปริงแอคชูเอเตอร์การติดตามไมโครมิเตอร์และการพึ่งพา opentelemetry เฉพาะจากไมโครมิเตอร์ในโครงการ

dependencies {
    implementation ' org.springframework.boot:spring-boot-starter-actuator '
    implementation ' io.micrometer:micrometer-tracing-bridge-otel '
    implementation ' io.opentelemetry:opentelemetry-exporter-otlp '
    .. .
}

ผู้ส่งออกที่จัดทำโดย Spring Boot Actuator Autoconfiguration เป็นผู้ส่งออก HTTP (ถั่ว OtlpHttpSpanExporter ) และสามารถกำหนดค่าผ่านคุณสมบัติได้ด้วยการกำหนดค่าการติดตามใน OtlpAutoConfiguration

 management :
  otlp :
    tracing :
      endpoint : http://localhost:4318/v1/traces

OpentElemetry รองรับคู่คีย์/ค่าเพิ่มเติม (เรียกว่า resource attributes ) ที่จะรวมอยู่ในข้อมูล telemetry Spring Boot Actuator ให้การกำหนดค่าอัตโนมัติสำหรับผู้ที่และทำให้สามารถเพิ่มแอตทริบิวต์ทรัพยากรใหม่ผ่านคุณสมบัติ แอตทริบิวต์ service.name OpentElemetry มาตรฐานมาตรฐานจะถูกกำหนดค่าโดยอัตโนมัติตามค่าของ spring.application.name (ถ้ากำหนด) หรืออื่น ๆ เป็นค่า application ชันเริ่มต้น

 management :
  opentelemetry :
    resource-attributes :
      cluster : local

ฉันสร้างแอปพลิเคชั่นตัวอย่างเพื่อแสดงการตั้งค่านี้

ออกร่องรอยการส่งออกผ่าน GRPC

ในปัญหานี้ในโครงการ Spring Boot มีการเพิ่มการกำหนดค่าอัตโนมัติสำหรับถั่ว OtlpHttpSpanExporter เพื่อส่งออกร่องรอยการส่งออกผ่าน HTTP

ข้อกำหนดทั่วไปคือการส่งออกร่องรอยผ่าน GRPC (วิธีการที่ใช้มากที่สุดใน opentelemetry) ปัจจุบันนักพัฒนาสามารถกำหนดค่า OtlpGrpcSpanExporter Bean ได้ด้วยตัวเอง มันคงจะดีถ้าสปริงบูตแอคทูเอเตอร์จะให้การกำหนดค่าอัตโนมัติสำหรับสิ่งนั้นเพื่อเพิ่มการ OtlpAutoConfiguration ที่มีอยู่

มีปัญหาเกี่ยวกับโครงการสปริงบูตเพื่อเพิ่มการกำหนดค่าอัตโนมัติดังกล่าว

สรุป

โดยรวมแล้วสิ่งเหล่านี้เป็นปัญหาและข้อเสนอแนะที่ฉันอธิบายมาจนถึงตอนนี้

การเปลี่ยนแปลงที่เสนอน้อยที่สุดเพื่อรวมการสนับสนุน opentelemetry ในฤดูใบไม้ผลิสำหรับตัวชี้วัดและร่องรอย

ไมโครมิเตอร์

• แนะนำการใช้งาน MeterRegistry ที่สร้างขึ้นบน opentelemetry และกำหนดค่าได้ผ่านวิธีการมาตรฐานเพื่อให้เป็นไปได้ที่จะแบ่งปันการกำหนดค่าระหว่างตัวชี้วัดและร่องรอย

สปริงบูตแอคทูเอเตอร์

• แนะนำการกำหนดค่าอัตโนมัติสำหรับการวัด opentelemetry OpenTelemetry และถั่ว Resource สามารถนำกลับมาใช้ใหม่ได้จากการกำหนดค่า opentelemetry ที่มีอยู่ นอกจากนั้นการกำหนดค่าอัตโนมัติควรกำหนดค่าเริ่มต้นสำหรับ SdkMeterProvider , OtlpHttpMetricExporter และ OtlpGrpcMetricExporter
• แนะนำการกำหนดค่าอัตโนมัติสำหรับการส่งออกร่องรอย opentelemetry ผ่าน GRPC โดยกำหนด OtlpGrpcSpanExporter Bean
• รวมคลาส OpentElemetry Autoconfiguration ข้ามตัวชี้วัดและร่องรอย opentelemetryautoconfiguration ที่มีอยู่สามารถใช้สำหรับการกำหนดค่าที่ใช้ร่วมกัน นอกจากนั้นจำเป็นต้องใช้คลาสการกำหนดค่าอัตโนมัติโดยเฉพาะเพื่อกำหนดค่าผู้ส่งออกเฉพาะสำหรับ telemetry แต่ละประเภท ร่องรอยมีอยู่แล้วใน OTLPAUTOCONFIGURATION

Spring Initializr

• หลังจากผ่านการเปลี่ยนแปลงก่อนหน้านี้ทั้งหมดมันควรจะกลายเป็นตัวเลือก opentelemetry ที่ตรงไปตรงมาไปยัง Spring Initializr การเพิ่มมันในขณะนี้ด้วยสถานะปัจจุบันของสิ่งต่าง ๆ มันอาจทำให้สิ่งต่าง ๆ สับสนเมื่อพิจารณาถึงวิธีการต่าง ๆ ในการกำหนดค่า opentelemtry ระหว่างตัวชี้วัดและร่องรอย

การเปลี่ยนแปลงเพิ่มเติมเพื่อขยายการสนับสนุน opentelemetry ในฤดูใบไม้ผลิเป็นบันทึก

สปริงบูตแอคทูเอเตอร์

• แนะนำการกำหนดค่าอัตโนมัติสำหรับบันทึก opentelemetry OpenTelemetry และถั่ว Resource สามารถนำกลับมาใช้ใหม่ได้จากการกำหนดค่า opentelemetry ที่มีอยู่ นอกจากนั้นการกำหนดค่าอัตโนมัติควรกำหนดค่าเริ่มต้นสำหรับ SdkLoggerProvider , OtlpHttpLogRecordExporter และ OtlpGrpcLogRecordExporter
• เพิ่มการสนับสนุนสำหรับ logback (ค่าเริ่มต้น) และ log4j2 สำหรับแรงบันดาลใจ OpentElemetry Java Instrumentation จัดเตรียม Appenders สำหรับ logback และ log4j2
• อาจเป็นปัญหาที่เกี่ยวข้องในโครงการสปริงบูต

การปรับปรุงเพิ่มเติม

• ปัญหาได้เปิดขึ้นเพื่อตรวจสอบวิธีการ จำกัด จำนวนถั่วที่กำหนดค่าได้ในปัจจุบันในการติดตาม OpenTelemetryAutoConfiguration (ปัญหานี้อาจได้รับการพิจารณาสำหรับ OpenTelemetryAutoConfiguration ทั่วโลกเมื่อการติดตามเฉพาะถูกลบ)