feat: opentelementry support #14668
feat: opentelementry support #14668
Conversation
github-actions
bot
added
dependencies
lib/utils/otel/metric.ts
Outdated
| }, | ||
| }); | ||
|
|
||
| export const metric_handler = { |
There was a problem hiding this comment.
| export const metric_handler = { | |
| export const metric = { |
There was a problem hiding this comment.
I'm not sure if the rename is necessary, the metric_handler here is just a wrapper around the aggregated metrics counter
There was a problem hiding this comment.
Or any other better var name?
incubator4
force-pushed
the
feat/otel
branch
2 times, most recently
from
2f42b79
to
704d639
Compare
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| "@opentelemetry/api": "^1.8.0", | ||
| "@opentelemetry/exporter-prometheus": "^0.49.1", | ||
| "@opentelemetry/exporter-trace-otlp-http": "^0.49.1", | ||
| "@opentelemetry/resources": "^1.22.0", | ||
| "@opentelemetry/sdk-metrics": "^1.22.0", | ||
| "@opentelemetry/sdk-trace-base": "^1.22.0", | ||
| "@opentelemetry/semantic-conventions": "^1.22.0", |
There was a problem hiding this comment.
| "@opentelemetry/api": "^1.8.0", | |
| "@opentelemetry/exporter-prometheus": "^0.49.1", | |
| "@opentelemetry/exporter-trace-otlp-http": "^0.49.1", | |
| "@opentelemetry/resources": "^1.22.0", | |
| "@opentelemetry/sdk-metrics": "^1.22.0", | |
| "@opentelemetry/sdk-trace-base": "^1.22.0", | |
| "@opentelemetry/semantic-conventions": "^1.22.0", | |
| "@opentelemetry/api": "1.8.0", | |
| "@opentelemetry/exporter-prometheus": "0.49.1", | |
| "@opentelemetry/exporter-trace-otlp-http": "0.49.1", | |
| "@opentelemetry/resources": "1.22.0", | |
| "@opentelemetry/sdk-metrics": "1.22.0", | |
| "@opentelemetry/sdk-trace-base": "1.22.0", | |
| "@opentelemetry/semantic-conventions": "1.22.0", |
Please pin the dependency version.
| @@ -158,6 +158,16 @@ Access code is the md5 generated based on the access key + route, eg: | |||
|
|
|||
| `SENTRY_ROUTE_TIMEOUT`: Report Sentry if route execution takes more than this milliseconds, default to `3000` | |||
|
|
|||
| ## Opentelementry Config | |||
There was a problem hiding this comment.
| ## Opentelementry Config | |
| ## OpenTelemetry Config |
| @@ -27,6 +28,7 @@ const app = new Hono(); | |||
| app.use(compress()); | |||
|
|
|||
| app.use(mLogger); | |||
| app.use(trace); | |||
There was a problem hiding this comment.
If DEBUG_INFO is set to false or any strings other than true, the debug info from RSSHub will be hidden and only available if the same string is provided as query string debug.
/metrics does not respect this behaviour currently.
The same also apply to ACCESS_KEY.
RSSHub/lib/middleware/access-control.ts
Line 15 in 15a51bd
There was a problem hiding this comment.
Basicly, metrics should be export with a external local port. In that case rsshub may handle another port with 127.0.0.1:9090 for example.
I'm not sure if an external port should be created, but it might be a better solution than modify if else for access-control.
And also should be with env to control local server enable or not.
Involved Issue / 该 PR 相关 Issue
Close #
Example for the Proposed Route(s) / 路由地址示例
New RSS Route Checklist / 新 RSS 路由检查表
PuppeteerNote / 说明
Implement opentelementry feature
metricsandtraceMetrics
metrics endpoint with
/metricslabels:
methodhttp method (example: GET/POST)pathrequest pathstatusresponse return status codeunitonly for bucket (example: second/millisecond)The following metric name supported for now.
request_totalrecord request with paramsrequest_error_totalrecord request error with paramsrequest_duration_seconds_bucketrecord request second with paramsrequest_duration_milliseconds_bucketrecord request millisecond with paramstrace
trace with opentelementry OTLP exporter, which could be collected by jaeger (for example)
endpoint follow OpenTelemetry Specification on Protocol Exporter.