Skip to content

Commit

Permalink
feat(ui): Adding new analytics charts for new users, top users past m…
Browse files Browse the repository at this point in the history 
…onth (#10344)

Co-authored-by: John Joyce <[email protected]>
Co-authored-by: John Joyce <[email protected]>
  • Loading branch information
@jjoyce0510
3 people authored Apr 24, 2024
1 parent a5d60b4 commit ec21b01
Show file tree
Hide file tree
Showing 7 changed files with 332 additions and 60 deletions.
246 changes: 202 additions & 44 deletions ...core/src/main/java/com/linkedin/datahub/graphql/analytics/resolver/GetChartsResolver.java
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
package com.linkedin.datahub.graphql.analytics.resolver;

import static com.linkedin.metadata.Constants.CORP_USER_ENTITY_NAME;
import static com.linkedin.metadata.Constants.CORP_USER_STATUS_LAST_MODIFIED_FIELD_NAME;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
Expand All @@ -9,17 +12,31 @@
import com.linkedin.datahub.graphql.generated.AnalyticsChart;
import com.linkedin.datahub.graphql.generated.AnalyticsChartGroup;
import com.linkedin.datahub.graphql.generated.BarChart;
import com.linkedin.datahub.graphql.generated.Cell;
import com.linkedin.datahub.graphql.generated.DateInterval;
import com.linkedin.datahub.graphql.generated.DateRange;
import com.linkedin.datahub.graphql.generated.EntityProfileParams;
import com.linkedin.datahub.graphql.generated.EntityType;
import com.linkedin.datahub.graphql.generated.LinkParams;
import com.linkedin.datahub.graphql.generated.NamedBar;
import com.linkedin.datahub.graphql.generated.NamedLine;
import com.linkedin.datahub.graphql.generated.Row;
import com.linkedin.datahub.graphql.generated.TableChart;
import com.linkedin.datahub.graphql.generated.TimeSeriesChart;
import com.linkedin.datahub.graphql.types.common.mappers.UrnToEntityMapper;
import com.linkedin.datahub.graphql.util.DateUtil;
import com.linkedin.entity.client.EntityClient;
import com.linkedin.metadata.Constants;
import com.linkedin.metadata.query.filter.Condition;
import com.linkedin.metadata.query.filter.ConjunctiveCriterion;
import com.linkedin.metadata.query.filter.ConjunctiveCriterionArray;
import com.linkedin.metadata.query.filter.Criterion;
import com.linkedin.metadata.query.filter.CriterionArray;
import com.linkedin.metadata.query.filter.Filter;
import com.linkedin.metadata.query.filter.SortCriterion;
import com.linkedin.metadata.query.filter.SortOrder;
import com.linkedin.metadata.search.SearchEntity;
import com.linkedin.metadata.search.SearchResult;
import graphql.schema.DataFetcher;
import graphql.schema.DataFetchingEnvironment;
import io.datahubproject.metadata.context.OperationContext;
Expand All @@ -28,6 +45,7 @@
import java.util.List;
import java.util.Optional;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.joda.time.DateTime;
Expand All @@ -41,14 +59,13 @@ public final class GetChartsResolver implements DataFetcher<List<AnalyticsChartG
private final EntityClient _entityClient;

@Override
public final List<AnalyticsChartGroup> get(DataFetchingEnvironment environment) throws Exception {
public List<AnalyticsChartGroup> get(DataFetchingEnvironment environment) throws Exception {
final QueryContext context = environment.getContext();

try {
return ImmutableList.of(
AnalyticsChartGroup.builder()
.setGroupId("DataHubUsageAnalytics")
.setTitle("DataHub Usage Analytics")
.setTitle("Usage Analytics")
.setCharts(getProductAnalyticsCharts(context.getOperationContext()))
.build(),
AnalyticsChartGroup.builder()
Expand Down Expand Up @@ -87,8 +104,106 @@ private TimeSeriesChart getActiveUsersTimeSeriesChart(
.build();
}

@Nullable
private AnalyticsChart getTopUsersChart(OperationContext opContext) {
try {
final DateUtil dateUtil = new DateUtil();
final DateRange trailingMonthDateRange = dateUtil.getTrailingMonthDateRange();
final List<String> columns = ImmutableList.of("Name", "Title", "Email");

final String topUsersTitle = "Top Users";
final List<Row> topUserRows =
_analyticsService.getTopNTableChart(
_analyticsService.getUsageIndexName(),
Optional.of(trailingMonthDateRange),
"actorUrn.keyword",
Collections.emptyMap(),
ImmutableMap.of(
"actorUrn.keyword",
ImmutableList.of("urn:li:corpuser:admin", "urn:li:corpuser:datahub")),
Optional.empty(),
30,
AnalyticsUtil::buildCellWithEntityLandingPage);
AnalyticsUtil.convertToUserInfoRows(opContext, _entityClient, topUserRows);
return TableChart.builder()
.setTitle(topUsersTitle)
.setColumns(columns)
.setRows(topUserRows)
.build();
} catch (Exception e) {
log.error("Failed to retrieve top users chart!", e);
return null;
}
}

private SearchResult searchForNewUsers(@Nonnull final OperationContext opContext)
throws Exception {
// Search for new users in the past month.
final DateUtil dateUtil = new DateUtil();
final DateRange trailingMonthDateRange = dateUtil.getTrailingMonthDateRange();
return _entityClient.search(
opContext,
CORP_USER_ENTITY_NAME,
"*",
new Filter()
.setOr(
new ConjunctiveCriterionArray(
ImmutableList.of(
new ConjunctiveCriterion()
.setAnd(
new CriterionArray(
ImmutableList.of(
new Criterion()
.setField(CORP_USER_STATUS_LAST_MODIFIED_FIELD_NAME)
.setCondition(Condition.GREATER_THAN)
.setValue(
String.valueOf(
trailingMonthDateRange.getStart())))))))),
new SortCriterion()
.setField(CORP_USER_STATUS_LAST_MODIFIED_FIELD_NAME)
.setOrder(SortOrder.DESCENDING),
0,
100);
}

@Nonnull
private Row buildNewUsersRow(@Nonnull final SearchEntity entity) {
final Row row = new Row();
row.setValues(ImmutableList.of(entity.getEntity().toString()));
final Cell cell = new Cell();
cell.setValue(entity.getEntity().toString());
cell.setEntity(UrnToEntityMapper.map(null, entity.getEntity()));
cell.setLinkParams(
new LinkParams(
null, new EntityProfileParams(entity.getEntity().toString(), EntityType.CORP_USER)));
row.setCells(ImmutableList.of(cell));
return row;
}

@Nullable
private AnalyticsChart getNewUsersChart(OperationContext opContext) {
try {
final List<String> columns = ImmutableList.of("Name", "Title", "Email");
final String newUsersTitle = "New Users";
final SearchResult result = searchForNewUsers(opContext);
final List<Row> newUserRows = new ArrayList<>();
for (SearchEntity entity : result.getEntities()) {
newUserRows.add(buildNewUsersRow(entity));
}
AnalyticsUtil.convertToUserInfoRows(opContext, _entityClient, newUserRows);
return TableChart.builder()
.setTitle(newUsersTitle)
.setColumns(columns)
.setRows(newUserRows)
.build();
} catch (Exception e) {
log.error("Failed to retrieve new users chart!", e);
return null;
}
}

/** TODO: Config Driven Charts Instead of Hardcoded. */
private List<AnalyticsChart> getProductAnalyticsCharts(@Nonnull OperationContext opContext)
private List<AnalyticsChart> getProductAnalyticsCharts(OperationContext opContext)
throws Exception {
final List<AnalyticsChart> charts = new ArrayList<>();
DateUtil dateUtil = new DateUtil();
Expand All @@ -97,20 +212,35 @@ private List<AnalyticsChart> getProductAnalyticsCharts(@Nonnull OperationContext
final DateTime startOfNextMonth = dateUtil.getStartOfNextMonth();
final DateRange trailingWeekDateRange = dateUtil.getTrailingWeekDateRange();

// WAU
charts.add(
getActiveUsersTimeSeriesChart(
startOfNextWeek.minusWeeks(10),
startOfNextWeek.minusMillis(1),
"Weekly Active Users",
DateInterval.WEEK));

// MAU
charts.add(
getActiveUsersTimeSeriesChart(
startOfNextMonth.minusMonths(12),
startOfThisMonth.minusMillis(1),
"Monthly Active Users",
DateInterval.MONTH));

String searchesTitle = "Searches Last Week";
// New users chart - past month
final AnalyticsChart newUsersChart = getNewUsersChart(opContext);
if (newUsersChart != null) {
charts.add(newUsersChart);
}

// Top users chart - past month
final AnalyticsChart topUsersChart = getTopUsersChart(opContext);
if (topUsersChart != null) {
charts.add(topUsersChart);
}

String searchesTitle = "Number of Searches";
DateInterval dailyInterval = DateInterval.DAY;
String searchEventType = "SearchEvent";

Expand All @@ -131,7 +261,7 @@ private List<AnalyticsChart> getProductAnalyticsCharts(@Nonnull OperationContext
.setLines(searchesTimeseries)
.build());

final String topSearchTitle = "Top Search Queries";
final String topSearchTitle = "Top Searches (Past Week)";
final List<String> columns = ImmutableList.of("Query", "Count");

final List<Row> topSearchQueries =
Expand All @@ -151,34 +281,8 @@ private List<AnalyticsChart> getProductAnalyticsCharts(@Nonnull OperationContext
.setRows(topSearchQueries)
.build());

final String sectionViewsTitle = "Section Views across Entity Types";
final List<NamedBar> sectionViewsPerEntityType =
_analyticsService.getBarChart(
_analyticsService.getUsageIndexName(),
Optional.of(trailingWeekDateRange),
ImmutableList.of("entityType.keyword", "section.keyword"),
ImmutableMap.of("type", ImmutableList.of("EntitySectionViewEvent")),
Collections.emptyMap(),
Optional.empty(),
true);
charts.add(
BarChart.builder().setTitle(sectionViewsTitle).setBars(sectionViewsPerEntityType).build());

final String actionsByTypeTitle = "Actions by Entity Type";
final List<NamedBar> eventsByEventType =
_analyticsService.getBarChart(
_analyticsService.getUsageIndexName(),
Optional.of(trailingWeekDateRange),
ImmutableList.of("entityType.keyword", "actionType.keyword"),
ImmutableMap.of("type", ImmutableList.of("EntityActionEvent")),
Collections.emptyMap(),
Optional.empty(),
true);
charts.add(BarChart.builder().setTitle(actionsByTypeTitle).setBars(eventsByEventType).build());

final String topViewedTitle = "Top Viewed Dataset";
final List<String> columns5 = ImmutableList.of("Dataset", "#Views");

final String topViewedDatasetsTitle = "Top Viewed Datasets (Past Week)";
final List<String> columns5 = ImmutableList.of("Name", "View Count");
final List<Row> topViewedDatasets =
_analyticsService.getTopNTableChart(
_analyticsService.getUsageIndexName(),
Expand All @@ -198,19 +302,75 @@ private List<AnalyticsChart> getProductAnalyticsCharts(@Nonnull OperationContext
_entityClient,
topViewedDatasets,
Constants.DATASET_ENTITY_NAME,
ImmutableSet.of(Constants.DATASET_KEY_ASPECT_NAME),
ImmutableSet.of(
Constants.DATASET_KEY_ASPECT_NAME, Constants.DATASET_PROPERTIES_ASPECT_NAME),
AnalyticsUtil::getDatasetName);
charts.add(
TableChart.builder()
.setTitle(topViewedTitle)
.setTitle(topViewedDatasetsTitle)
.setColumns(columns5)
.setRows(topViewedDatasets)
.build());

final String topViewedDashboardsTitle = "Top Viewed Dashboards (Past Week)";
final List<String> columns6 = ImmutableList.of("Name", "View Count");
final List<Row> topViewedDashboards =
_analyticsService.getTopNTableChart(
_analyticsService.getUsageIndexName(),
Optional.of(trailingWeekDateRange),
"entityUrn.keyword",
ImmutableMap.of(
"type",
ImmutableList.of("EntityViewEvent"),
"entityType.keyword",
ImmutableList.of(EntityType.DASHBOARD.name())),
Collections.emptyMap(),
Optional.empty(),
10,
AnalyticsUtil::buildCellWithEntityLandingPage);
AnalyticsUtil.hydrateDisplayNameForTable(
opContext,
_entityClient,
topViewedDashboards,
Constants.DASHBOARD_ENTITY_NAME,
ImmutableSet.of(Constants.DASHBOARD_INFO_ASPECT_NAME),
AnalyticsUtil::getDashboardName);
charts.add(
TableChart.builder()
.setTitle(topViewedDashboardsTitle)
.setColumns(columns6)
.setRows(topViewedDashboards)
.build());

final String sectionViewsTitle = "Tab Views By Entity Type (Past Week)";
final List<NamedBar> sectionViewsPerEntityType =
_analyticsService.getBarChart(
_analyticsService.getUsageIndexName(),
Optional.of(trailingWeekDateRange),
ImmutableList.of("entityType.keyword", "section.keyword"),
ImmutableMap.of("type", ImmutableList.of("EntitySectionViewEvent")),
Collections.emptyMap(),
Optional.empty(),
true);
charts.add(
BarChart.builder().setTitle(sectionViewsTitle).setBars(sectionViewsPerEntityType).build());

final String actionsByTypeTitle = "Actions By Entity Type (Past Week)";
final List<NamedBar> eventsByEventType =
_analyticsService.getBarChart(
_analyticsService.getUsageIndexName(),
Optional.of(trailingWeekDateRange),
ImmutableList.of("entityType.keyword", "actionType.keyword"),
ImmutableMap.of("type", ImmutableList.of("EntityActionEvent")),
Collections.emptyMap(),
Optional.empty(),
true);
charts.add(BarChart.builder().setTitle(actionsByTypeTitle).setBars(eventsByEventType).build());

return charts;
}

private List<AnalyticsChart> getGlobalMetadataAnalyticsCharts(@Nonnull OperationContext opContext)
private List<AnalyticsChart> getGlobalMetadataAnalyticsCharts(OperationContext opContext)
throws Exception {
final List<AnalyticsChart> charts = new ArrayList<>();
// Chart 1: Entities per domain
Expand Down Expand Up @@ -239,7 +399,7 @@ private List<AnalyticsChart> getGlobalMetadataAnalyticsCharts(@Nonnull Operation
AnalyticsUtil::getPlatformName);
if (!entitiesPerDomain.isEmpty()) {
charts.add(
BarChart.builder().setTitle("Entities per Domain").setBars(entitiesPerDomain).build());
BarChart.builder().setTitle("Entities By Domain").setBars(entitiesPerDomain).build());
}

// Chart 2: Entities per platform
Expand All @@ -261,10 +421,7 @@ private List<AnalyticsChart> getGlobalMetadataAnalyticsCharts(@Nonnull Operation
AnalyticsUtil::getPlatformName);
if (!entitiesPerPlatform.isEmpty()) {
charts.add(
BarChart.builder()
.setTitle("Entities per Platform")
.setBars(entitiesPerPlatform)
.build());
BarChart.builder().setTitle("Assets By Platform").setBars(entitiesPerPlatform).build());
}

// Chart 3: Entities per term
Expand All @@ -286,7 +443,8 @@ private List<AnalyticsChart> getGlobalMetadataAnalyticsCharts(@Nonnull Operation
Constants.GLOSSARY_TERM_KEY_ASPECT_NAME, Constants.GLOSSARY_TERM_INFO_ASPECT_NAME),
AnalyticsUtil::getTermName);
if (!entitiesPerTerm.isEmpty()) {
charts.add(BarChart.builder().setTitle("Entities per Term").setBars(entitiesPerTerm).build());
charts.add(
BarChart.builder().setTitle("Entities With Term").setBars(entitiesPerTerm).build());
}

// Chart 4: Entities per fabric type
Expand All @@ -301,7 +459,7 @@ private List<AnalyticsChart> getGlobalMetadataAnalyticsCharts(@Nonnull Operation
false);
if (entitiesPerEnv.size() > 1) {
charts.add(
BarChart.builder().setTitle("Entities per Environment").setBars(entitiesPerEnv).build());
BarChart.builder().setTitle("Entities By Environment").setBars(entitiesPerEnv).build());
}

return charts;
Expand Down
Loading

0 comments on commit ec21b01

Please sign in to comment.