kumaab commented on code in PR #1103: URL: https://github.com/apache/ranger/pull/1103#discussion_r3787747673
########## unixauthservice/src/main/java/org/apache/ranger/authentication/metrics/source/RangerUserSyncSourceSyncSource.java: ########## @@ -0,0 +1,45 @@ +/* + * 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.ranger.authentication.metrics.source; + +import org.apache.ranger.authentication.metrics.UserSyncMetricsFetcher; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Component; + +import java.util.Map; + +@Component +public class RangerUserSyncSourceSyncSource extends RangerUserSyncSourceBase { + @Autowired + private UserSyncMetricsFetcher userSyncMetricsFetcher; + + public RangerUserSyncSourceSyncSource() { + super("usersync", "SinkSource"); + } + + @Override + protected void refresh() { + Map<String, Long> totalSyncSourceCount = userSyncMetricsFetcher.getTotalSyncSourceCount(); + for (String key : totalSyncSourceCount.keySet()) { + metricsMap.put(key, Review Comment: Use single line for adding an entry to a map (see comment on `UserSyncMetricsWrapper.java`), check other references as well. ########## unixauthservice/src/main/java/org/apache/ranger/authentication/rest/MetricsREST.java: ########## @@ -0,0 +1,119 @@ +/* + * 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.ranger.authentication.rest; + +import org.apache.ranger.authentication.metrics.UserSyncMetricsWrapper; +import org.apache.ranger.plugin.model.RangerMetrics; +import org.apache.ranger.plugin.util.RangerMetricsUtil; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Component; + +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.Produces; +import javax.ws.rs.core.MediaType; + +import java.lang.management.ManagementFactory; +import java.lang.management.RuntimeMXBean; +import java.util.LinkedHashMap; +import java.util.Map; + +@Path("metrics") +@Component +public class MetricsREST { + private static final Logger LOG = LoggerFactory.getLogger(MetricsREST.class); + + private static final RuntimeMXBean RUNTIME = ManagementFactory.getRuntimeMXBean(); + private static final String JVM_MACHINE_ACTUAL_NAME = RUNTIME.getVmName(); + private static final String VERSION = RUNTIME.getVmVersion(); + private static final String JVM_MACHINE_REPRESENTATION_NAME = RUNTIME.getName(); + private static final String JVM_VENDOR_NAME = RUNTIME.getVmVendor(); + + RangerMetricsUtil jvmMetricUtil = new RangerMetricsUtil(); + + @Autowired + private UserSyncMetricsWrapper userSyncMetricsWrapper; + + @GET + @Path("/status") + @Produces(MediaType.APPLICATION_JSON) + public RangerMetrics getStatus() { + if (LOG.isDebugEnabled()) { + LOG.debug("==> MetricsREST.getStatus()"); + } + Map<String, Object> jvm = new LinkedHashMap<>(); + Map<String, Object> vmDetails = new LinkedHashMap<>(); + vmDetails.put("JVM Machine Actual Name", JVM_MACHINE_ACTUAL_NAME); + vmDetails.put("version", VERSION); + vmDetails.put("JVM Machine Representation Name", JVM_MACHINE_REPRESENTATION_NAME); + vmDetails.put("Up time of JVM", RUNTIME.getUptime()); + vmDetails.put("JVM Vendor Name", JVM_VENDOR_NAME); + vmDetails.putAll(jvmMetricUtil.getValues()); + jvm.put("jvm", vmDetails); + + if (LOG.isDebugEnabled()) { + LOG.debug("<== MetricsREST.getStatus() " + jvm); + } + + return new RangerMetrics(jvm); + } + + @GET + @Path("/prometheus") + @Produces(MediaType.TEXT_PLAIN) + public String getMetricsPrometheus() { + if (LOG.isDebugEnabled()) { + LOG.debug("===>> MetricsREST.getMetricsPrometheus()"); + } + String ret = ""; + try { + ret = userSyncMetricsWrapper.getRangerMetricsInPrometheusFormat(); + } catch (Exception e) { + LOG.error("MetricsREST.getMetricsPrometheus(): Exception occured while getting metric.", e); + } + + if (LOG.isDebugEnabled()) { + LOG.debug("<<=== MetricsREST.getMetricsPrometheus() {}" + ret); + } + return ret; + } + + @GET + @Path("/json") + @Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML}) + public Map<String, Map<String, Object>> getMetricsJson() { + if (LOG.isDebugEnabled()) { + LOG.debug("===>> MetricsREST.getMetricsJson()"); + } + Map<String, Map<String, Object>> ret = null; + try { + ret = userSyncMetricsWrapper.getRangerMetricsInJsonFormat(); + } catch (Exception e) { + LOG.error("MetricsREST.getMetricsJson(): Exception occured while getting metric.", e); + } + + if (LOG.isDebugEnabled()) { Review Comment: References of `LOG.isDebugEnabled()` should be removed, check all such places in this PR, see: https://cwiki.apache.org/confluence/spaces/RANGER/pages/334761073/Apache+Ranger+Java+Style+Guide ########## unixauthservice/scripts/ranger-usersync-services.sh: ########## @@ -92,7 +93,17 @@ if [ "${action}" == "START" ]; then export PATH=$JAVA_HOME/bin:$PATH fi - cp="${cdir}/dist/*:${cdir}/lib/*:${cdir}/conf:${RANGER_USERSYNC_HADOOP_CONF_DIR}/*" + if [ -z "${RANGER_USERSYNC_LOG_DIR}" ]; then + RANGER_USERSYNC_LOG_DIR=/var/log/ranger/usersync + fi + + if [ ! -d RANGER_USERSYNC_LOG_DIR ]; then + mkdir -p $RANGER_USERSYNC_LOG_DIR + chmod 777 $RANGER_USERSYNC_LOG_DIR Review Comment: 777 gives all perms to everyone, use appropriate perms (minimally required). ########## unixauthservice/src/main/webapp/WEB-INF/security/spring-security.xml: ########## @@ -0,0 +1,56 @@ +<?xml version="1.0" encoding="UTF-8"?> Review Comment: Why is this file even required? for eg: ranger-admin web server does not use `spring-security.xml` ########## unixauthservice/src/main/java/org/apache/ranger/authentication/metrics/UserSyncMetricsWrapper.java: ########## @@ -0,0 +1,96 @@ +/* + * 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.ranger.authentication.metrics; + +import org.apache.ranger.authentication.metrics.source.RangerUserSyncSourceApis; +import org.apache.ranger.authentication.metrics.source.RangerUserSyncSourceCache; +import org.apache.ranger.authentication.metrics.source.RangerUserSyncSourceRoleStatus; +import org.apache.ranger.authentication.metrics.source.RangerUserSyncSourceSyncSource; +import org.apache.ranger.metrics.RangerMetricsSystemWrapper; +import org.apache.ranger.metrics.wrapper.RangerMetricsSourceWrapper; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.stereotype.Service; + +import javax.annotation.PostConstruct; + +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.Map; + +@Service +public class UserSyncMetricsWrapper { + private static final Logger LOG = LoggerFactory.getLogger(UserSyncMetricsWrapper.class); + + private static final String context = "usersync"; + + private final RangerMetricsSystemWrapper rangerMetricsSystemWrapper = new RangerMetricsSystemWrapper(); + + @Autowired + private RangerUserSyncSourceApis rangerUserSyncSourceApis; + + @Autowired + private RangerUserSyncSourceCache rangerUserSyncSourceCache; + + @Autowired + private RangerUserSyncSourceSyncSource rangerUserSyncSourceSyncSource; + + @Autowired + private RangerUserSyncSourceRoleStatus rangerUserSyncSourceRoleStatus; + + @PostConstruct + public void init() { + if (LOG.isDebugEnabled()) { + LOG.debug("===>> UserSyncMetricsWrapper.init()"); + } + + // Source + List<RangerMetricsSourceWrapper> sourceWrappers = new ArrayList<>(); + sourceWrappers.add(new RangerMetricsSourceWrapper("UserSyncSource", "Ranger UserSync metrics", context, Review Comment: Reformat the lines into single lines, see: https://github.com/apache/ranger/blob/master/dev-support/RangerCodeScheme-IntelliJ.xml#L19 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
