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.

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

[APM] Add span icons for AWS and Azure services #96284

Closed
AlexanderWert opened this issue Apr 6, 2021 · 15 comments · Fixed by #101901
Closed

[APM] Add span icons for AWS and Azure services #96284

AlexanderWert opened this issue Apr 6, 2021 · 15 comments · Fixed by #101901
Labels
Team:APM All issues that need APM UI Team support

Comments

@AlexanderWert
Copy link
Member

AlexanderWert commented Apr 6, 2021

APM agents are introducing new instrumentations for AWS (elastic/apm#408) and Azure (elastic/apm#410) services. To represent these instrumentations with proper icons in trace views and the service map, we need to add corresponding span icons to the UI.

Type, Subtype:

Backend type subtype icon
AWS S3  storage s3   AWS icon 
AWS DynamoDB  db dynamodb  AWS icon 
AWS SQS  messaging sqs   AWS icon 
AWS SNS  messaging sns   AWS icon 
Azure Blob Storage  storage azureblob  Azure icon 
Azure Table Storage  storage azuretable  Azure icon 
Azure File Share Storage  storage azurefile  Azure icon 
Azure Queue Storage  messaging azurequeue  Azure icon 
Azure Service Bus  messaging azureservicebus  Azure icon 
Azure Cosmos DB  db cosmosdb  Azure icon 
@AlexanderWert AlexanderWert added the Team:APM All issues that need APM UI Team support label Apr 6, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/apm-ui (Team:apm)

@formgeist
Copy link
Contributor

@AlexanderWert Wondering if we want to have more detail in the icons than the AWS and Azure icons themselves? For the person implementing this, EUI already has these two as third party icons but they'll need to converted to custom SVGs (one for each light and dark theme).

Screenshot 2021-04-06 at 10 37 09

Screenshot 2021-04-06 at 10 38 59

@AlexanderWert
Copy link
Member Author

@formgeist Good question. I could imagine that having service-specific icons could provide additional value in identifying the services:
image

But I don't have a strong opinion on this. @alex-fedotyev , @cyrille-leclerc what do you think?

@cyrille-leclerc
Copy link
Contributor

Thanks for looking at this.
An icon with a textual description makes sense to me. I add textual description (e.g. "Amazon SQS", "Amazon S3"...) because the icon is not enough to be intuitive.
AWS service icons are hard to remember but they look & feel AWS so I like the idea to use them rather than using the generic AWS icon.
Maybe the textual description can be a tool tip if we want to be compact.

@formgeist
Copy link
Contributor

@AlexanderWert Do you know if we're going to display AWS DynamoDB as the span.destination.service.name or will it be subtype? Wondering if we'd already show the explicit name as part of this e.g. in the Service map.

Screenshot 2021-04-08 at 08 59 57

@AlexanderWert
Copy link
Member Author

@formgeist Ss of the current SPEC, the fields for DynamoDb will be:

field value
name e.g. DynamoDB UpdateItem my_table
type db
subtype dynamodb
action query
span.destination.service.name dynamodb
span.destination.service.type db
span.destination.service.resource dynamodb

Thus, yes, if the display name is using the subtype or span.destination.service.name, then it will show the explicit name

@formgeist
Copy link
Contributor

@AlexanderWert Excellent! Thanks for confirming 👍

@formgeist formgeist removed their assignment Jun 10, 2021
@formgeist
Copy link
Contributor

So we should move forward with using the generic provider logos like suggested above and the subtype label will be present in the node label and popover.

dynamodb

@sorenlouv
Copy link
Member

sorenlouv commented Jun 10, 2021

@AlexanderWert Is this issue just about DynamoDB? (only seeing type and subtype for that here #96284 (comment))

@formgeist
Copy link
Contributor

@sqren The description refers to elastic/apm#410 and elastic/apm#408 for both AWS and Azure subtypes that we'll need to show either icons for.

@sorenlouv
Copy link
Member

@formgeist I did look at those but it was still not clear to me what the span.type and span.subtype would be. Are there some sample documents somewhere?

@sorenlouv
Copy link
Member

Generally, what I'd like is for this info to be in the issue description (if possible).

@AlexanderWert
Copy link
Member Author

@sqren , see table above (in the description). Is that what you were asking for?

@sorenlouv
Copy link
Member

@AlexanderWert That's perfect, thanks!

@sorenlouv
Copy link
Member

sorenlouv commented Jun 14, 2021

@AlexanderWert fyi, these are the supported types/subtypes after my changes in #101901:

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:APM All issues that need APM UI Team support
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants