AMBARI-21804. Add configurable management endpoints to Log Search (oleewere)
Project: http://git-wip-us.apache.org/repos/asf/ambari/repo Commit: http://git-wip-us.apache.org/repos/asf/ambari/commit/f7d10f43 Tree: http://git-wip-us.apache.org/repos/asf/ambari/tree/f7d10f43 Diff: http://git-wip-us.apache.org/repos/asf/ambari/diff/f7d10f43 Branch: refs/heads/feature-branch-AMBARI-21307 Commit: f7d10f437535aebcef05cbbbe458fb7e8264ade5 Parents: 68b95cf Author: oleewere <oleew...@gmail.com> Authored: Wed Aug 23 18:12:11 2017 +0200 Committer: oleewere <oleew...@gmail.com> Committed: Fri Aug 25 12:30:53 2017 +0200 ---------------------------------------------------------------------- .../ambari-logsearch-server/pom.xml | 11 ++++ .../logsearch/conf/ApplicationConfig.java | 7 ++- .../ambari/logsearch/conf/SecurityConfig.java | 4 +- .../ambari/logsearch/doc/DocConstants.java | 1 + .../health/AbstractSolrHealthIndicator.java | 59 ++++++++++++++++++++ .../health/SolrAuditLogsHealthIndicator.java | 38 +++++++++++++ .../health/SolrEventHistoryHealthIndicator.java | 37 ++++++++++++ .../health/SolrServiceLogsHealthIndicator.java | 38 +++++++++++++ .../ambari/logsearch/manager/InfoManager.java | 19 +++++++ .../ambari/logsearch/rest/InfoResource.java | 8 +++ .../src/main/resources/default.properties | 23 ++++++++ .../src/main/resources/info.properties | 17 ++++++ 12 files changed, 259 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ambari/blob/f7d10f43/ambari-logsearch/ambari-logsearch-server/pom.xml ---------------------------------------------------------------------- diff --git a/ambari-logsearch/ambari-logsearch-server/pom.xml b/ambari-logsearch/ambari-logsearch-server/pom.xml index c0ae16e..e60cc14 100755 --- a/ambari-logsearch/ambari-logsearch-server/pom.xml +++ b/ambari-logsearch/ambari-logsearch-server/pom.xml @@ -45,6 +45,12 @@ </activation> <build> <finalName>LogSearch</finalName> + <resources> + <resource> + <directory>src/main/resources</directory> + <filtering>true</filtering> + </resource> + </resources> <pluginManagement> <plugins> <plugin> @@ -251,6 +257,11 @@ </dependency> <dependency> <groupId>org.springframework.boot</groupId> + <artifactId>spring-boot-starter-actuator</artifactId> + <version>${spring-boot.version}</version> + </dependency> + <dependency> + <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-jetty</artifactId> <version>${spring-boot.version}</version> </dependency> http://git-wip-us.apache.org/repos/asf/ambari/blob/f7d10f43/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/conf/ApplicationConfig.java ---------------------------------------------------------------------- diff --git a/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/conf/ApplicationConfig.java b/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/conf/ApplicationConfig.java index 3d30c2a..d957349 100644 --- a/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/conf/ApplicationConfig.java +++ b/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/conf/ApplicationConfig.java @@ -31,7 +31,12 @@ import java.io.IOException; import static org.apache.ambari.logsearch.common.LogSearchConstants.LOGSEARCH_PROPERTIES_FILE; @Configuration -@PropertySource(value = {"classpath:default.properties", "classpath:"+ LOGSEARCH_PROPERTIES_FILE}) +@PropertySource(value = { + "classpath:default.properties", + "classpath:info.properties", + "classpath:"+ LOGSEARCH_PROPERTIES_FILE + } +) public class ApplicationConfig { @Bean http://git-wip-us.apache.org/repos/asf/ambari/blob/f7d10f43/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/conf/SecurityConfig.java ---------------------------------------------------------------------- diff --git a/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/conf/SecurityConfig.java b/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/conf/SecurityConfig.java index 2758388..038ba5c 100644 --- a/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/conf/SecurityConfig.java +++ b/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/conf/SecurityConfig.java @@ -115,7 +115,7 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter { .addFilterAfter(logsearchAuditLogFilter(), LogsearchSecurityContextFormationFilter.class) .addFilterAfter(logsearchServiceLogFilter(), LogsearchSecurityContextFormationFilter.class) .addFilterAfter(logSearchConfigStateFilter(), LogsearchSecurityContextFormationFilter.class) - .addFilterBefore(corsFilter(), LogsearchSecurityContextFormationFilter.class) + .addFilterBefore(logsearchCorsFilter(), LogsearchSecurityContextFormationFilter.class) .addFilterBefore(logsearchJwtFilter(), LogsearchSecurityContextFormationFilter.class) .logout() .logoutUrl("/logout.html") @@ -124,7 +124,7 @@ public class SecurityConfig extends WebSecurityConfigurerAdapter { } @Bean - public LogsearchCorsFilter corsFilter() { + public LogsearchCorsFilter logsearchCorsFilter() { return new LogsearchCorsFilter(logSearchHttpHeaderConfig); } http://git-wip-us.apache.org/repos/asf/ambari/blob/f7d10f43/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/doc/DocConstants.java ---------------------------------------------------------------------- diff --git a/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/doc/DocConstants.java b/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/doc/DocConstants.java index da0a8bb..34e923f 100644 --- a/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/doc/DocConstants.java +++ b/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/doc/DocConstants.java @@ -101,6 +101,7 @@ public class DocConstants { } public class PublicOperationDescriptions { + public static final String GET_APP_DETAILS_OD = "Get application details."; public static final String GET_AUTH_DETAILS_OD = "Get authentication details."; public static final String GET_ALL_PROPERTIES_INFO_OD = "List all available properties for Log Search and Log Feeder"; public static final String GET_LOGSEARCH_PROPERTIES_INFO_OD = "List all available properties for Log Search property file (e.g: logsearch.properties/logfeeder.properties)"; http://git-wip-us.apache.org/repos/asf/ambari/blob/f7d10f43/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/health/AbstractSolrHealthIndicator.java ---------------------------------------------------------------------- diff --git a/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/health/AbstractSolrHealthIndicator.java b/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/health/AbstractSolrHealthIndicator.java new file mode 100644 index 0000000..59936e9 --- /dev/null +++ b/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/health/AbstractSolrHealthIndicator.java @@ -0,0 +1,59 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.ambari.logsearch.health; + +import org.apache.solr.client.solrj.SolrClient; +import org.apache.solr.client.solrj.SolrQuery; +import org.apache.solr.client.solrj.response.QueryResponse; +import org.springframework.boot.actuate.health.AbstractHealthIndicator; +import org.springframework.boot.actuate.health.Health; +import org.springframework.boot.actuate.health.Status; +import org.springframework.data.solr.core.SolrTemplate; + +public abstract class AbstractSolrHealthIndicator extends AbstractHealthIndicator { + + @Override + protected void doHealthCheck(Health.Builder builder) throws Exception { + Status status = Status.DOWN; + String errorDetails = null; + if (getSolrTemplate() != null && getSolrTemplate().getSolrClient() != null) { + try { + SolrClient solrClient = getSolrTemplate().getSolrClient(); + SolrQuery q = new SolrQuery("*:*"); + q.setRows(0); + QueryResponse response = solrClient.query(q); + if (response.getStatus() == 0) { + status = Status.UP; + if (response.getResults() != null) { + builder.withDetail("numDocs", response.getResults().getNumFound()); + } + } + } catch (Exception e) { + errorDetails = e.getMessage(); + } + } + builder.status(status); + if (errorDetails != null) { + builder.withDetail("error", errorDetails); + } + } + + public abstract SolrTemplate getSolrTemplate(); + +} http://git-wip-us.apache.org/repos/asf/ambari/blob/f7d10f43/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/health/SolrAuditLogsHealthIndicator.java ---------------------------------------------------------------------- diff --git a/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/health/SolrAuditLogsHealthIndicator.java b/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/health/SolrAuditLogsHealthIndicator.java new file mode 100644 index 0000000..901dfc0 --- /dev/null +++ b/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/health/SolrAuditLogsHealthIndicator.java @@ -0,0 +1,38 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.ambari.logsearch.health; + +import org.apache.ambari.logsearch.dao.AuditSolrDao; +import org.springframework.data.solr.core.SolrTemplate; + +import javax.inject.Inject; +import javax.inject.Named; + +@Named +public class SolrAuditLogsHealthIndicator extends AbstractSolrHealthIndicator { + + @Inject + private AuditSolrDao auditSolrDao; + + @Override + public SolrTemplate getSolrTemplate() { + return auditSolrDao.getSolrTemplate(); + } + +} http://git-wip-us.apache.org/repos/asf/ambari/blob/f7d10f43/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/health/SolrEventHistoryHealthIndicator.java ---------------------------------------------------------------------- diff --git a/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/health/SolrEventHistoryHealthIndicator.java b/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/health/SolrEventHistoryHealthIndicator.java new file mode 100644 index 0000000..bbb1f47 --- /dev/null +++ b/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/health/SolrEventHistoryHealthIndicator.java @@ -0,0 +1,37 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.ambari.logsearch.health; + +import org.apache.ambari.logsearch.dao.EventHistorySolrDao; +import org.springframework.data.solr.core.SolrTemplate; + +import javax.inject.Inject; +import javax.inject.Named; + +@Named +public class SolrEventHistoryHealthIndicator extends AbstractSolrHealthIndicator { + + @Inject + private EventHistorySolrDao eventHistorySolrDao; + + @Override + public SolrTemplate getSolrTemplate() { + return eventHistorySolrDao.getSolrTemplate(); + } +} http://git-wip-us.apache.org/repos/asf/ambari/blob/f7d10f43/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/health/SolrServiceLogsHealthIndicator.java ---------------------------------------------------------------------- diff --git a/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/health/SolrServiceLogsHealthIndicator.java b/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/health/SolrServiceLogsHealthIndicator.java new file mode 100644 index 0000000..ff95bee --- /dev/null +++ b/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/health/SolrServiceLogsHealthIndicator.java @@ -0,0 +1,38 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.ambari.logsearch.health; + +import org.apache.ambari.logsearch.dao.ServiceLogsSolrDao; +import org.springframework.data.solr.core.SolrTemplate; + +import javax.inject.Inject; +import javax.inject.Named; + +@Named +public class SolrServiceLogsHealthIndicator extends AbstractSolrHealthIndicator { + + @Inject + private ServiceLogsSolrDao serviceLogsSolrDao; + + @Override + public SolrTemplate getSolrTemplate() { + return serviceLogsSolrDao.getSolrTemplate(); + } + +} http://git-wip-us.apache.org/repos/asf/ambari/blob/f7d10f43/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/manager/InfoManager.java ---------------------------------------------------------------------- diff --git a/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/manager/InfoManager.java b/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/manager/InfoManager.java index 2f63492..c17f24a 100644 --- a/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/manager/InfoManager.java +++ b/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/manager/InfoManager.java @@ -28,6 +28,7 @@ import org.apache.ambari.logsearch.common.PropertyDescriptionStorage; import org.apache.ambari.logsearch.common.ShipperConfigDescriptionStorage; import org.apache.ambari.logsearch.model.response.PropertyDescriptionData; import org.apache.ambari.logsearch.model.response.ShipperConfigDescriptionData; +import org.springframework.beans.factory.annotation.Value; import javax.inject.Inject; import javax.inject.Named; @@ -35,6 +36,16 @@ import javax.inject.Named; @Named public class InfoManager extends JsonManagerBase { + @Value("${logsearch.app.version:}") + private String logsearchAppVersion; + + @Value("${logsearch.solr.version:}") + private String logsearchSolrVersion; + + @Value("${java.runtime.version}") + private String javaRuntimeVersion; + + @Inject private AuthPropsConfig authPropsConfig; @@ -44,6 +55,14 @@ public class InfoManager extends JsonManagerBase { @Inject private ShipperConfigDescriptionStorage shipperConfigDescriptionStore; + public Map<String, String> getApplicationInfo() { + Map<String, String> appMap = new HashMap<>(); + appMap.put("application.version", logsearchAppVersion); + appMap.put("solr.version", logsearchSolrVersion); + appMap.put("java.runtime.version", javaRuntimeVersion); + return appMap; + } + public Map<String, Boolean> getAuthMap() { Map<String, Boolean> authMap = new HashMap<>(); authMap.put("external", authPropsConfig.isAuthExternalEnabled()); http://git-wip-us.apache.org/repos/asf/ambari/blob/f7d10f43/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/rest/InfoResource.java ---------------------------------------------------------------------- diff --git a/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/rest/InfoResource.java b/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/rest/InfoResource.java index e49be90..9507c25 100644 --- a/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/rest/InfoResource.java +++ b/ambari-logsearch/ambari-logsearch-server/src/main/java/org/apache/ambari/logsearch/rest/InfoResource.java @@ -37,6 +37,7 @@ import java.util.Map; import static org.apache.ambari.logsearch.doc.DocConstants.PublicOperationDescriptions.GET_ALL_PROPERTIES_INFO_OD; import static org.apache.ambari.logsearch.doc.DocConstants.PublicOperationDescriptions.GET_ALL_SHIPPER_CONFIG_INFO_OD; +import static org.apache.ambari.logsearch.doc.DocConstants.PublicOperationDescriptions.GET_APP_DETAILS_OD; import static org.apache.ambari.logsearch.doc.DocConstants.PublicOperationDescriptions.GET_LOGSEARCH_PROPERTIES_INFO_OD; import static org.apache.ambari.logsearch.doc.DocConstants.PublicOperationDescriptions.GET_AUTH_DETAILS_OD; @@ -50,6 +51,13 @@ public class InfoResource { private InfoManager infoManager; @GET + @Produces({"application/json"}) + @ApiOperation(GET_APP_DETAILS_OD) + public Map<String, String> getApplicationInfo() { + return infoManager.getApplicationInfo(); + } + + @GET @Path("/auth") @Produces({"application/json"}) @ApiOperation(GET_AUTH_DETAILS_OD) http://git-wip-us.apache.org/repos/asf/ambari/blob/f7d10f43/ambari-logsearch/ambari-logsearch-server/src/main/resources/default.properties ---------------------------------------------------------------------- diff --git a/ambari-logsearch/ambari-logsearch-server/src/main/resources/default.properties b/ambari-logsearch/ambari-logsearch-server/src/main/resources/default.properties index 4c74142..a8c5a4b 100644 --- a/ambari-logsearch/ambari-logsearch-server/src/main/resources/default.properties +++ b/ambari-logsearch/ambari-logsearch-server/src/main/resources/default.properties @@ -24,3 +24,26 @@ logsearch.login.credentials.file=user_pass.json logsearch.cert.folder.location=/etc/ambari-logsearch-portal/conf/keys logsearch.cert.algorithm=sha256WithRSAEncryption + +management.security.enabled=false + +endpoints.auditevents.enabled=true +endpoints.configprops.enabled=true +endpoints.env.enabled=true +endpoints.dump.enabled=true +endpoints.heapdump.enabled=true +endpoints.metrics.enabled=true +endpoints.health.enabled=true +endpoints.health.path=/ping + +endpoints.actuator.enabled=false +endpoints.autoconfig.enabled=false +endpoints.beans.enabled=false +endpoints.flyway.enabled=false +endpoints.info.enabled=false +endpoints.liquibase.enabled=false +endpoints.mappings.enabled=false +endpoints.shutdown.enabled=false +endpoints.trace.enabled=false + +management.health.solr.enabled=false http://git-wip-us.apache.org/repos/asf/ambari/blob/f7d10f43/ambari-logsearch/ambari-logsearch-server/src/main/resources/info.properties ---------------------------------------------------------------------- diff --git a/ambari-logsearch/ambari-logsearch-server/src/main/resources/info.properties b/ambari-logsearch/ambari-logsearch-server/src/main/resources/info.properties new file mode 100644 index 0000000..03d9c91 --- /dev/null +++ b/ambari-logsearch/ambari-logsearch-server/src/main/resources/info.properties @@ -0,0 +1,17 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +logsearch.app.version=1.0.0-${project.version} +logsearch.solr.version=${solr.version} \ No newline at end of file
