Skip to content

Latest commit

 

History

History
67 lines (57 loc) · 3.22 KB

demo-app-specification.md

File metadata and controls

67 lines (57 loc) · 3.22 KB
Raw

Specification for the Getting Started Guide demo applications

Application

  1. Must use port 8080

  2. User must be able to access the endpoint http://localhost:8080/fibonacci?n=[input], and endpoint should return the following JSON response:

  • For valid input, {"n":5,"result":5}
  • For invalid input, {"message":"n must be 1 <= n <= 90."}
  1. Must configure the OpenTelemetry SDK according to New Relic best practices.
  • Should use be kept up to date with latest version of OpenTelemetry API / SDK for language.
  • Should export data to New Relic using OTLP, preferring http/protobuf where there is no clear preference.
  • Should enable gzip compression.
  • Should configure metrics w/ delta temporality.
  • Should configure attribute limits.
  • Should use the standard environment variables for configuration rather than programmatic or other means:
    • OTEL_SERVICE_NAME=getting-started-<lang>>
    • OTEL_EXPORTER_OTLP_HEADERS=api-key=<your_license_key>
    • OTEL_EXPORTER_OTLP_ENDPOINT=https://otlp.nr-data.net
    • OTEL_EXPORTER_OTLP_COMPRESSION=gzip
    • OTEL_EXPORTER_OTLP_PROTOCOL=http/protobuf
    • OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE=DELTA
    • OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT=4095
  1. Must accept input as n, with the valid input range as 1 <= n <= 90
  2. The application must emit the following telemetry:
  • Traces
    • Root span
      • The root span may be emitted manually when the endpoint is invoked or preferrably by instrumentation if available in the language.
    • Child span
      • This span should represent the fibonacci calculation.
      • Span name = fibonacci
      • Span kind = internal
      • Attributes
        • fibonacci.n, with the value of n representing the user's input
        • fibonacci.result, with the value of result representing the result of the user’s input
      • Span event
        • When an error occurs, an exception event should be added as follows:
        • Span status = ERROR
        • Status description: n must be 1 <= n <= 90.
  • Metrics
    • Counter namedfibonacci.invocations
      • Attributes
        • Counter description: Measures the number of times the fibonacci method is invoked.
        • fibonacci.valid.n, with a boolean value indicating whether n was valid or not
  • Logs
    • Output the following when n is valid: Compute fibonacci(n) = result
    • Output the following when n is invalid: Failed to compute fibonacci(n)

Validation

Use the following NRQL query to verify that data is flowing from all apps:

FROM Span, Metric, Log 
SELECT 
  filter(count(*), WHERE eventType() = 'Log') as 'log_recprd_count',
  filter(count(*), WHERE eventType() = 'Metric') as 'metric_point_count',
  filter(count(*), WHERE eventType() = 'Span') as 'span_count'
WHERE service.name LIKE 'getting%' AND metricName NOT LIKE 'apm%' FACET service.name SINCE 5 minute ago

This outputs a table of each service name, and columns containing the number of log records, metric data points, and spans. Each language should have a row, and the point counts should all be non-zero except:

  • getting-started-ruby doesn't have support for metrics or logs
  • getting-started-javascript doesn't have support for logs