Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: propagate Publish caller through all pubsub metrics #2231

Merged
merged 4 commits into from
Aug 1, 2024
Merged

feat: propagate Publish caller through all pubsub metrics #2231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b6918fa
init
deniseli Jul 31, 2024
18b2d8f
fixes
deniseli Aug 1, 2024
50494ee
migration file
deniseli Aug 1, 2024
06fced5
rm not null
deniseli Aug 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions backend/controller/cronjobs/sql/models.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 6 additions & 5 deletions backend/controller/dal/pubsub.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ func (d *DAL) PublishEventForTopic(ctx context.Context, module, topic, caller st
Key: model.NewTopicEventKey(module, topic),
Module: module,
Topic: topic,
Caller: caller,
Payload: payload,
})
observability.PubSub.Published(ctx, module, topic, caller, err)
Expand Down Expand Up @@ -65,12 +66,12 @@ func (d *DAL) ProgressSubscriptions(ctx context.Context, eventConsumptionDelay t
for _, subscription := range subs {
nextCursor, err := tx.db.GetNextEventForSubscription(ctx, eventConsumptionDelay, subscription.Topic, subscription.Cursor)
if err != nil {
observability.PubSub.PropagationFailed(ctx, "GetNextEventForSubscription", subscription.Topic.Payload.Name, subscriptionRef(subscription), optional.None[schema.RefKey]())
observability.PubSub.PropagationFailed(ctx, "GetNextEventForSubscription", subscription.Topic.Payload, nextCursor.Caller, subscriptionRef(subscription), optional.None[schema.RefKey]())
return 0, fmt.Errorf("failed to get next cursor: %w", dalerrs.TranslatePGError(err))
}
nextCursorKey, ok := nextCursor.Event.Get()
if !ok {
observability.PubSub.PropagationFailed(ctx, "GetNextEventForSubscription-->Event.Get", subscription.Topic.Payload.Name, subscriptionRef(subscription), optional.None[schema.RefKey]())
observability.PubSub.PropagationFailed(ctx, "GetNextEventForSubscription-->Event.Get", subscription.Topic.Payload, nextCursor.Caller, subscriptionRef(subscription), optional.None[schema.RefKey]())
return 0, fmt.Errorf("could not find event to progress subscription: %w", dalerrs.TranslatePGError(err))
}
if !nextCursor.Ready {
Expand All @@ -86,7 +87,7 @@ func (d *DAL) ProgressSubscriptions(ctx context.Context, eventConsumptionDelay t

err = tx.db.BeginConsumingTopicEvent(ctx, subscription.Key, nextCursorKey)
if err != nil {
observability.PubSub.PropagationFailed(ctx, "BeginConsumingTopicEvent", subscription.Topic.Payload.Name, subscriptionRef(subscription), optional.Some(subscriber.Sink))
observability.PubSub.PropagationFailed(ctx, "BeginConsumingTopicEvent", subscription.Topic.Payload, nextCursor.Caller, subscriptionRef(subscription), optional.Some(subscriber.Sink))
return 0, fmt.Errorf("failed to progress subscription: %w", dalerrs.TranslatePGError(err))
}

Expand All @@ -105,11 +106,11 @@ func (d *DAL) ProgressSubscriptions(ctx context.Context, eventConsumptionDelay t
MaxBackoff: subscriber.MaxBackoff,
})
if err != nil {
observability.PubSub.PropagationFailed(ctx, "CreateAsyncCall", subscription.Topic.Payload.Name, subscriptionRef(subscription), optional.Some(subscriber.Sink))
observability.PubSub.PropagationFailed(ctx, "CreateAsyncCall", subscription.Topic.Payload, nextCursor.Caller, subscriptionRef(subscription), optional.Some(subscriber.Sink))
return 0, fmt.Errorf("failed to schedule async task for subscription: %w", dalerrs.TranslatePGError(err))
}

observability.PubSub.SinkCalled(ctx, subscription.Topic.Payload.Name, subscriptionRef(subscription), subscriber.Sink)
observability.PubSub.SinkCalled(ctx, subscription.Topic.Payload, nextCursor.Caller, subscriptionRef(subscription), subscriber.Sink)
successful++
}
return successful, nil
Expand Down
36 changes: 26 additions & 10 deletions backend/controller/observability/pubsub.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,17 @@ import (
"go.opentelemetry.io/otel/metric/noop"

"github.com/TBD54566975/ftl/backend/schema"
"github.com/TBD54566975/ftl/internal/model"
"github.com/TBD54566975/ftl/internal/observability"
)

// To learn more about how sinks and subscriptions work together, check out the
// https://tbd54566975.github.io/ftl/docs/reference/pubsub/
const (
pubsubMeterName = "ftl.pubsub"
pubsubTopicNameAttr = "ftl.pubsub.topic.name"
pubsubCallerVerbNameAttr = "ftl.pubsub.publish.caller.verb.name"
pubsubTopicRefAttr = "ftl.pubsub.topic.ref"
pubsubTopicModuleAttr = "ftl.pubsub.topic.module.name"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How is this different to .ref above?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They're the same, but the consensus in Slack (with the rest of the otel folks) was to just log both. It is possible to filter by module-only using the ref by doing a string match in datadog, but that's a little more annoying than having this attr here. WDYT? I could just remove the duplicated module attrs everywhere.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh hmm it looks like DD's "split graph" feature doesn't support any special string matching; you have to just pick an attribute and it slices all the graphs by that. So that would be an argument to keep module in there :/

pubsubCallerVerbRefAttr = "ftl.pubsub.publish.caller.verb.ref"
pubsubSubscriptionRefAttr = "ftl.pubsub.subscription.ref"
pubsubSubscriptionModuleAttr = "ftl.pubsub.subscription.module.name"
pubsubSinkRefAttr = "ftl.pubsub.sink.ref"
Expand Down Expand Up @@ -79,22 +81,28 @@ func handleInitCounterError(errs error, err error, counterName string) error {
func (m *PubSubMetrics) Published(ctx context.Context, module, topic, caller string, maybeErr error) {
attrs := []attribute.KeyValue{
attribute.String(observability.ModuleNameAttribute, module),
attribute.String(pubsubTopicNameAttr, topic),
attribute.String(pubsubCallerVerbNameAttr, caller),
attribute.String(pubsubTopicRefAttr, schema.RefKey{Module: module, Name: topic}.String()),
attribute.String(pubsubCallerVerbRefAttr, schema.RefKey{Module: module, Name: caller}.String()),
attribute.Bool(observability.StatusSucceededAttribute, maybeErr == nil),
}

m.published.Add(ctx, 1, metric.WithAttributes(attrs...))
}

func (m *PubSubMetrics) PropagationFailed(ctx context.Context, failedOp, topic string, subscription schema.RefKey, sink optional.Option[schema.RefKey]) {
func (m *PubSubMetrics) PropagationFailed(ctx context.Context, failedOp string, topic model.TopicPayload, optCaller optional.Option[string], subscription schema.RefKey, sink optional.Option[schema.RefKey]) {
attrs := []attribute.KeyValue{
attribute.String(pubsubFailedOperationAttr, failedOp),
attribute.String(pubsubTopicNameAttr, topic),
attribute.String(pubsubTopicRefAttr, schema.RefKey{Module: topic.Module, Name: topic.Name}.String()),
attribute.String(pubsubTopicModuleAttr, topic.Module),
attribute.String(pubsubSubscriptionRefAttr, subscription.String()),
attribute.String(pubsubSubscriptionModuleAttr, subscription.Module),
}

caller, ok := optCaller.Get()
if ok {
attrs = append(attrs, attribute.String(pubsubCallerVerbRefAttr, schema.RefKey{Module: topic.Module, Name: caller}.String()))
}

if sinkRef, ok := sink.Get(); ok {
attrs = append(attrs, attribute.String(pubsubSinkRefAttr, sinkRef.String()))
attrs = append(attrs, attribute.String(pubsubSinkModuleAttr, sinkRef.Module))
Expand All @@ -103,12 +111,20 @@ func (m *PubSubMetrics) PropagationFailed(ctx context.Context, failedOp, topic s
m.propagationFailed.Add(ctx, 1, metric.WithAttributes(attrs...))
}

func (m *PubSubMetrics) SinkCalled(ctx context.Context, topic string, subscription, sink schema.RefKey) {
m.sinkCalled.Add(ctx, 1, metric.WithAttributes(
attribute.String(pubsubTopicNameAttr, topic),
func (m *PubSubMetrics) SinkCalled(ctx context.Context, topic model.TopicPayload, optCaller optional.Option[string], subscription, sink schema.RefKey) {
attrs := []attribute.KeyValue{
attribute.String(pubsubTopicRefAttr, schema.RefKey{Module: topic.Module, Name: topic.Name}.String()),
attribute.String(pubsubTopicModuleAttr, topic.Module),
attribute.String(pubsubSubscriptionRefAttr, subscription.String()),
attribute.String(pubsubSubscriptionModuleAttr, subscription.Module),
attribute.String(pubsubSinkRefAttr, sink.String()),
attribute.String(pubsubSinkModuleAttr, sink.Module),
))
}

caller, ok := optCaller.Get()
if ok {
attrs = append(attrs, attribute.String(pubsubCallerVerbRefAttr, schema.RefKey{Module: topic.Module, Name: caller}.String()))
}

m.sinkCalled.Add(ctx, 1, metric.WithAttributes(attrs...))
}
1 change: 1 addition & 0 deletions backend/controller/sql/models.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion backend/controller/sql/queries.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -647,6 +647,7 @@ VALUES (
INSERT INTO topic_events (
"key",
topic_id,
caller,
payload
)
VALUES (
Expand All @@ -658,6 +659,7 @@ VALUES (
WHERE modules.name = sqlc.arg('module')::TEXT
AND topics.name = sqlc.arg('topic')::TEXT
),
sqlc.arg('caller'),
sqlc.arg('payload')
);

Expand Down Expand Up @@ -690,6 +692,7 @@ WITH cursor AS (
SELECT events."key" as event,
events.payload,
events.created_at,
events.caller,
NOW() - events.created_at >= sqlc.arg('consumption_delay')::interval AS ready
FROM topics
LEFT JOIN topic_events as events ON events.topic_id = topics.id
Expand Down Expand Up @@ -762,4 +765,4 @@ WHERE id = $1::BIGINT;
-- name: GetTopicEvent :one
SELECT *
FROM topic_events
WHERE id = $1::BIGINT;
WHERE id = $1::BIGINT;
14 changes: 11 additions & 3 deletions backend/controller/sql/queries.sql.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions backend/controller/sql/schema/20240731230343_create_topic_events_caller.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
-- migrate:up

ALTER TABLE topic_events
ADD COLUMN caller TEXT;

-- migrate:down
1 change: 1 addition & 0 deletions common/configuration/sql/models.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading